CoreProtocol RFC project
https://rfc.coreprotocol.org/
- Astro 36.5%
- TypeScript 34.6%
- CSS 11.5%
- Shell 8.2%
- JavaScript 5%
- Other 4.2%
This pull request implements lefthook for automatic builds, linting and formatting before pushing, makes sure that lefthook gets installed upon packages install, as well as optimizes a few configurations. Co-authored-by: Ty Eggen <t####.e####@gmail.com> Reviewed-on: #3 Reviewed-by: Enot (ded) Skelly <enot@noreply.interspatial.ca> |
||
|---|---|---|
| .forgejo/workflows | ||
| .vscode | ||
| docker | ||
| docs/rfcs | ||
| public/assets | ||
| src | ||
| tools | ||
| .dockerignore | ||
| .editorconfig | ||
| .envrc | ||
| .gitignore | ||
| .prettierignore | ||
| astro.config.ts | ||
| default.nix | ||
| Dockerfile | ||
| eslint.config.mjs | ||
| justfile | ||
| lefthook.yml | ||
| LICENSE.md | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| prettier.config.mjs | ||
| README.md | ||
| tsconfig.json | ||
Astro Starter Kit: Minimal
pnpm create astro@latest -- --template minimal
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
🚀 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.
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm dev |
Starts local dev server at localhost:4321 |
pnpm build |
Build your production site to ./dist/ |
pnpm preview |
Preview your build locally, before deploying |
pnpm astro ... |
Run CLI commands like astro add, astro check |
pnpm astro -- --help |
Get help using the Astro CLI |
👀 Want to learn more?
Feel free to check our documentation or jump into our Discord server.