Skip to content

Commit 8e45133

Browse files
authoredDec 18, 2024
Updated readme file (#11)
1 parent 9bfa01e commit 8e45133

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed
 

Diff for: ‎README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
1-
# Website
1+
# OneGround Development Portal
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
Source code for [dev.oneground.nl](https://dev.oneground.nl) development portal.
44

5-
### Installation
5+
This website is built using [Docusaurus](https://docusaurus.io/).
6+
7+
## Run Locally
8+
9+
### Packages Installation
610

711
```
8-
$ yarn
12+
$ npm install
913
```
1014

11-
### Local Development
15+
Before you begin, make sure to install all packages using this command.
16+
17+
### Start Development
1218

1319
```
14-
$ yarn start
20+
$ npm start
1521
```
1622

1723
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1824

1925
### Build
2026

2127
```
22-
$ yarn build
28+
$ npm build
2329
```
2430

2531
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2632

27-
### Deployment
28-
29-
Using SSH:
33+
### Format Code
3034

3135
```
32-
$ USE_SSH=true yarn deploy
36+
$ npm run format
3337
```
3438

35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
39+
Before creating a new commit or pull request, ensure all code is formatted using this command. This is necessary because our pull request build will fail if the code is not properly formatted.
4040

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
41+
Source code is formatted using [Prettier](https://prettier.io/).

0 commit comments

Comments
 (0)