From 5b5dcb32ecbc126d300069d779744d1e81e6c238 Mon Sep 17 00:00:00 2001 From: christiansamaniego-okta <199278128+christiansamaniego-okta@users.noreply.github.com> Date: Fri, 21 Feb 2025 18:20:35 -0500 Subject: [PATCH] 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 <199278128+christiansamaniego-okta@users.noreply.github.com> --------- Co-authored-by: Byron Motoche <116190812+byron-okta@users.noreply.github.com> --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 8e09a5a2..c79ca634 100644 --- a/README.md +++ b/README.md @@ -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!