You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
4
4
5
-
### Installation
5
+
This website is built using [Docusaurus](https://docusaurus.io/).
6
+
7
+
## Run Locally
8
+
9
+
### Packages Installation
6
10
7
11
```
8
-
$ yarn
12
+
$ npm install
9
13
```
10
14
11
-
### Local Development
15
+
Before you begin, make sure to install all packages using this command.
16
+
17
+
### Start Development
12
18
13
19
```
14
-
$ yarn start
20
+
$ npm start
15
21
```
16
22
17
23
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18
24
19
25
### Build
20
26
21
27
```
22
-
$ yarn build
28
+
$ npm build
23
29
```
24
30
25
31
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26
32
27
-
### Deployment
28
-
29
-
Using SSH:
33
+
### Format Code
30
34
31
35
```
32
-
$ USE_SSH=true yarn deploy
36
+
$ npm run format
33
37
```
34
38
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.
40
40
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