Skip to content

A template to create Astro sites that utilize your own custom version of bootstrap

Notifications You must be signed in to change notification settings

Ship-Sail/astro-bootstrap-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Astro + Bootstrap Starter Kit 🚀

📚 Usage

Install Dependencies:

npm install

Development Shorthand Workflow:

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

⛩️ Project Structure

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.

✏️ Customizing Bootstrap

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.

🧞 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
npm run sass:watch Watch your Sass files for changes
npm run sass:build Build your CSS files from Sass

About

A template to create Astro sites that utilize your own custom version of bootstrap

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published