Thank you for taking the time to read the documentation for the NX Academy Website.
Here are the key points you need to remember:
- NX Academy uses Astro JS.
- We strive to minimize JavaScript usage on the client side.
- We do not use a CSS framework and instead rely on Vanilla CSS.
- We aim to be as accessible as possible.
- Apart from this README, all content is written in French.
- We are currently working on creating valuable cheatsheets, which we refer to in French as "Fiches techniques."
- We use Figma to help us designing the website and it's accessible to everyone. Yeah, it's pretty rough at the moment!
Once you have cloned the repo, the following commands should be available. They 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 |
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
│ └── components/
│ └── Header.astro
│ └── layouts/
│ └── CheatSheetsLayout.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.
Layouts serve as wrappers for page content, helping to keep your base code DRY.
Currently, we do not accept external contributors. We are a small team working to find the right balance. Once we achieve this balance, we will open up for external contributions.