Skip to content

Commit 80cccb5

Browse files
committed
Updated README
1 parent aff55bd commit 80cccb5

File tree

2 files changed

+40
-30
lines changed

2 files changed

+40
-30
lines changed

README.md

+2-30
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,10 @@
11
# HackHPI Website
22

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
284

295
All commands are run from the root of the project, from a terminal:
306

317
| Command | Action |
328
| :--------------------- | :------------------------------------------------- |
339
| `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 |
10+
| `npm run dev` | Starts local dev server at `localhost:3000` |

_old/README_astro.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# HackHPI Website
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
28+
29+
All commands are run from the root of the project, from a terminal:
30+
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 |

0 commit comments

Comments
 (0)