Skip to content

Commit 5b5dcb3

Browse files
Update README.md (#741)
* Update README.md This change adds a section on the README.md file including the steps to run the project locally * Update README.md Co-authored-by: christiansamaniego-okta <[email protected]> --------- Co-authored-by: Byron Motoche <[email protected]>
1 parent 049250d commit 5b5dcb3

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,4 +115,36 @@ To run tests, execute:
115115

116116
Look at the end of the [Gruntfile](/Gruntfile.js) for other common tasks.
117117

118+
### How to run project locally
119+
120+
- Make sure that you run these commands using Node `v16.x.x`.
121+
122+
- Clone the project:
123+
124+
```bash
125+
git clone [email protected]:jsonwebtoken/jsonwebtoken.github.io.git
126+
```
127+
- Make the project directory your current directory:
128+
129+
```bash
130+
cd jsonwebtoken.github.io
131+
```
132+
133+
- Install required dependencies:
134+
135+
```bash
136+
npm install
137+
```
138+
- Build the project:
139+
140+
```bash
141+
npm run build
142+
```
143+
- Run the development server:
144+
145+
```bash
146+
npm run start
147+
```
148+
- Visit: [http://localhost:3000](http://localhost:3000)
149+
118150
### Happy hacking!

0 commit comments

Comments
 (0)