|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# Astro Starter Kit: Basics |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +```sh |
| 4 | +pnpm create astro@latest -- --template basics |
| 5 | +``` |
4 | 6 |
|
5 | | -First, run the development server: |
| 7 | +[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) |
| 8 | +[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) |
| 9 | +[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) |
6 | 10 |
|
7 | | -```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | | -# or |
14 | | -bun dev |
15 | | -``` |
| 11 | +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
16 | 12 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 13 | + |
18 | 14 |
|
19 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 15 | +## 🚀 Project Structure |
20 | 16 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 17 | +Inside of your Astro project, you'll see the following folders and files: |
22 | 18 |
|
23 | | -## Learn More |
| 19 | +```text |
| 20 | +/ |
| 21 | +├── public/ |
| 22 | +│ └── favicon.svg |
| 23 | +├── src/ |
| 24 | +│ ├── layouts/ |
| 25 | +│ │ └── Layout.astro |
| 26 | +│ └── pages/ |
| 27 | +│ └── index.astro |
| 28 | +└── package.json |
| 29 | +``` |
24 | 30 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 31 | +To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). |
26 | 32 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 33 | +## 🧞 Commands |
29 | 34 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 35 | +All commands are run from the root of the project, from a terminal: |
31 | 36 |
|
32 | | -## Deploy on Vercel |
| 37 | +| Command | Action | |
| 38 | +| :------------------------ | :----------------------------------------------- | |
| 39 | +| `pnpm install` | Installs dependencies | |
| 40 | +| `pnpm dev` | Starts local dev server at `localhost:4321` | |
| 41 | +| `pnpm build` | Build your production site to `./dist/` | |
| 42 | +| `pnpm preview` | Preview your build locally, before deploying | |
| 43 | +| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | |
| 44 | +| `pnpm astro -- --help` | Get help using the Astro CLI | |
33 | 45 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 46 | +## 👀 Want to learn more? |
35 | 47 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 48 | +Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
0 commit comments