Skip to content

Commit

Permalink
Update README.md (#741)
Browse files Browse the repository at this point in the history
* 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 <199278128+christiansamaniego-okta@users.noreply.github.com>

---------

Co-authored-by: Byron Motoche <116190812+byron-okta@users.noreply.github.com>
  • Loading branch information
christiansamaniego-okta and byron-okta authored Feb 21, 2025
1 parent 049250d commit 5b5dcb3
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,36 @@ To run tests, execute:

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

### How to run project locally

- Make sure that you run these commands using Node `v16.x.x`.

- Clone the project:

```bash
git clone org-6887375@github.com:jsonwebtoken/jsonwebtoken.github.io.git
```
- Make the project directory your current directory:

```bash
cd jsonwebtoken.github.io
```

- Install required dependencies:

```bash
npm install
```
- Build the project:

```bash
npm run build
```
- Run the development server:

```bash
npm run start
```
- Visit: [http://localhost:3000](http://localhost:3000)

### Happy hacking!

0 comments on commit 5b5dcb3

Please sign in to comment.