Skip to content

Update README.md #741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 21, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update README.md
This change adds a section on the README.md file including the steps to run the project locally
  • Loading branch information
christiansamaniego-okta authored Feb 21, 2025
commit 4db14bee2e7966735fc7f0da75c8613cab0d0279
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 you have Node version <= 16 installed.

- 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!