Inside of your Astro project, you'll see the following folders and files:
/
āāā public/
ā āāā favicon.svg
ā āāā icon.png
ā āāā site.webmanifest
āāā src/
ā āāā actions/
ā āāā assets/
ā āāā components/
ā āāā data/
ā āāā interfaces/
ā āāā layouts/
ā āāā lib/
ā āāā middleware/
ā āāā pages/
ā āāā stores/
ā āāā styles/
āāā astro.config.mjs
āāā package.json
āāā tailwind.config.mjs
āāā tsconfig.json
āāā Other config files...
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, can be placed in the public/
directory.
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
npm install |
Installs dependencies |
node --run dev |
Starts local dev server at localhost:4321 |
node --run build |
Build your production site to ./dist/ |
node --run preview |
Preview your build locally, before deploying |
node --run astro ... |
Run CLI commands like astro add , astro check |
node --run astro -- --help |
Get help using the Astro CLI |
This project uses a Docker-based deployment. The Dockerfile
is set up to build and run the application in a production environment.