- Astro - The web framework for content-driven websites.
- Typescript - JavaScript with syntax for types.
- Tailwindcss - A utility-first CSS framework for rapidly building custom designs.
- tailwindcss-animated - Extended animation utilities for Tailwind CSS.
- fontsource - Self-host Open Source fonts in neatly bundled NPM packages.
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
Make sure you have setup your local Git Hooks:
git config core.hooksPath .githooks
This will make sure your commit messages follow the Conventional Commits Specification.
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 |
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 |
Feel free to check our documentation or jump into our Discord server.