diff options
| author | Andrew Lee <andrew@alee14.me> | 2025-02-21 17:38:43 -0500 |
|---|---|---|
| committer | Andrew Lee <andrew@alee14.me> | 2025-02-21 17:38:43 -0500 |
| commit | ebaa56401efd9b14ecef922db8c2f6eac732a4d6 (patch) | |
| tree | e81f25087eb14b2b89132e7d89108beb349e77a5 /README.md | |
| download | bnbmc-website-ebaa56401efd9b14ecef922db8c2f6eac732a4d6.tar.gz bnbmc-website-ebaa56401efd9b14ecef922db8c2f6eac732a4d6.tar.bz2 bnbmc-website-ebaa56401efd9b14ecef922db8c2f6eac732a4d6.zip | |
Initial commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff19a3e --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# Astro Starter Kit: Basics + +```sh +npm create astro@latest -- --template basics +``` + +[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) +[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) +[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) + +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! + + + +## 🚀 Project Structure + +Inside of your Astro project, you'll see the following folders and files: + +```text +/ +├── public/ +│ └── favicon.svg +├── src/ +│ ├── layouts/ +│ │ └── Layout.astro +│ └── pages/ +│ └── index.astro +└── package.json +``` + +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/). + +## 🧞 Commands + +All commands are run from the root of the project, from a terminal: + +| Command | Action | +| :------------------------ | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:4321` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro -- --help` | Get help using the Astro CLI | + +## 👀 Want to learn more? + +Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
