|
1 | 1 | # HackHPI Website |
2 | 2 |
|
3 | | -## π Project Structure |
4 | | - |
5 | | -Inside of your Astro project, you'll see the following folders and files: |
6 | | - |
7 | | -``` |
8 | | -/ |
9 | | -βββ public/ |
10 | | -β βββ favicon.svg |
11 | | -βββ src/ |
12 | | -β βββ components/ |
13 | | -β β βββ Card.astro |
14 | | -β βββ layouts/ |
15 | | -β β βββ Layout.astro |
16 | | -β βββ pages/ |
17 | | -β βββ index.astro |
18 | | -βββ package.json |
19 | | -``` |
20 | | - |
21 | | -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. |
22 | | - |
23 | | -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. |
24 | | - |
25 | | -Any static assets, like images, can be placed in the `public/` directory. |
26 | | - |
27 | | -## π§ Commands |
| 3 | +## Commands |
28 | 4 |
|
29 | 5 | All commands are run from the root of the project, from a terminal: |
30 | 6 |
|
31 | | -| Command | Action | |
32 | | -| :--------------------- | :------------------------------------------------- | |
33 | | -| `npm install` | Installs dependencies | |
34 | | -| `npm run dev` | Starts local dev server at `localhost:3000` | |
35 | | -| `npm run build` | Build your production site to `./dist/` | |
36 | | -| `npm run preview` | Preview your build locally, before deploying | |
37 | | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` | |
38 | | -| `npm run astro --help` | Get help using the Astro CLI | |
| 7 | +| Command | Action | |
| 8 | +| :--------------------- |:--------------------------------------------| |
| 9 | +| `npm install` | Installs dependencies | |
| 10 | +| `npm run dev` | Starts local dev server at `localhost:3000` | |
| 11 | +| `npm run build` | Build your production site to `./dist/` | |
| 12 | +| `npm run preview` | Check formatting | |
0 commit comments