Skip to content

Commit 9dcfd50

Browse files
committed
Add instruction on How to build locally
1 parent 31b2cfe commit 9dcfd50

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,29 @@
1-
# Website
1+
# Project web page
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
This website is built using [Docusaurus](https://docusaurus.io/) and hosted on GitHub Pages.
44

5-
### Installation
5+
## How to build locally
66

7-
```
8-
$ yarn
9-
```
7+
To build and serve the website locally, follow these steps:
108

11-
### Local Development
12-
13-
```
14-
$ yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
9+
1. **Clone the repository**:
10+
```bash
11+
git clone [email protected]:KPI-Rover/KPI-Rover.github.io.git
12+
cd KPI-Rover.github.io
13+
```
14+
2. **Install dependencies:** Make sure you have Node.js installed. Then, run:
15+
```bash
16+
npm install
17+
```
18+
3. **Build the site:**
19+
```bash
20+
npm run build
21+
```
22+
4. **Serve the site locally:**
23+
```bash
24+
npm run serve
25+
```
26+
5. **Develop locally:** If you want to develop and see changes in real-time, you can use:
27+
```bash
28+
npm run start
29+
```

0 commit comments

Comments
 (0)