https://github.com/datagrove/astro-homeschool-template
https://github.com/datagrove/astro-homeschool-template
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/datagrove/astro-homeschool-template
- Owner: datagrove
- License: mit
- Created: 2023-03-15T21:39:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-21T20:24:10.000Z (about 3 years ago)
- Last Synced: 2025-01-06T22:31:06.433Z (over 1 year ago)
- Language: Astro
- Size: 2.26 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: License.md
Awesome Lists containing this project
README
## 🚀 Project Structure
```
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── content/
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, should be placed in the appropriate subdirectory of the `public/` directory.
## 🧞 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:3000` |
| `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 |