npm install
This project makes use of concurrently which allows us to run both of our dev commands in a single command. This is placed in an npm script called start
so it can be run as follows:
npm start
Individual commands are broken down below
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
├── src/
│ └── 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, can be placed in the public/
directory.
To customize, add the Bootstrap variables to the bootstrap.scss
file. You can look at the file node_modules/bootstrap/dist/scss/_variables.scss
for a list of all the variables. Do NOT edit the variables.scss
file directly, as it will be overwritten when you update Bootstrap.
To add your own custom styles, use the styles.scss
file.
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 |
npm run sass:watch |
Watch your Sass files for changes |
npm run sass:build |
Build your CSS files from Sass |