Made possible with the contributions of the BOSC community. 🚀
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 |
Feel free to check Contribution Methods and follow Code of Conduct before contributing.
Make sure that Prettier is installed in your text editor. Add this to your settings.json
in VS Code, as Prettier alone will not format Astro files correctly. You need this additional formatter for Astro. The npm plugins are taken care with devDependencies you don't have to worry about that.
{ "prettier.documentSelectors": ["**/*.astro"], "[astro]": { "editor.defaultFormatter": "esbenp.prettier-vscode" } }
You can also run this command for installing the extension. Open up the terminal in vscode and paste this line .
ext install astro-build.astro-vscode
If you do not find the issue you are looking for, please create a new issue after reviewing our website.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Astro documentation.
npm run astro ...
Run CLI commands likeastro add
,astro check
npm run astro -- --help
Get help using the Astro CLI
The project is built using Astro.js and Tailwind CSS. Here's a quick look at the project structure:
.
├── .astro
│ ├── settings.json
│ └── types.d.ts
├── astro.config.mjs
├── public/
# Any static assets, like images, can be placed in the `public/` directory.
├── src
│ ├── components
# There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
│ │ ├── Data/
│ │ ├── Icons/
│ │ ├── Navbar.astro
│ │ └── Topic.astro
│ ├── env.d.ts
│ ├── layouts
│ │ └── Layout.astro
│ ├── pages
# Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
│ │ ├── about.astro
│ │ ├── blog.astro
│ │ ├── blogs
│ │ │ └── [id].astro
│ │ └── index.astro
│ └── styles
│ └── global.css
└── tsconfig.json