irsooti / firestarter

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hedwig

πŸš€ Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
β”œβ”€β”€ public/
β”‚   └── favicon.svg
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ feature-x/
β”‚   β”‚   └── ComponentName.astro
β”‚   β”‚   └── AnotherComponentName.astro 
β”‚   β”œβ”€β”€ shared/
β”‚   β”‚   └── Card.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/feature-x/, (replace "x" with any component name that you want) but that's where we like to put any Astro/React/Vue/Svelte/Preact components or something related to the feature.

Any static assets, like images, can be placed in 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

Tools used

Mockup

TBD

Code of Conduct

Contributor Covenant

License

The project is published under the MIT license. Feel free to clone and modify repo as you want, but don't forget to add a reference to authors :)

About

License:Other


Languages

Language:JavaScript 43.9%Language:HTML 28.7%Language:Astro 23.0%Language:Dockerfile 2.3%Language:TypeScript 2.1%