Skip to content

Commit

Permalink
feat(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
f-steel committed Jul 10, 2024
1 parent d055282 commit 979dd20
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@

1. Clone the project: `git clone https://github.com/AirWalk-Digital/airview-next`
2. in VScode - "Open in Container" using remote containers [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
3. Add required .env, github-app-private-key.pem, sharepoint-app-private-key.pem & .npmrc
2.1 Run `docker run -d --name redis -p 6379:6379 -p 8001:8001 redis/redis-stack:latest` to start redis container
3. Add required .env (see .env.example for content), github-app-private-key.pem, sharepoint-app-private-key.pem & .npmrc
3.1 Access to aws portal is required to get the access keys from Secrets manger (.pem)
4. Install dependencies: `npm i`
5. Run the dev server: `npm run dev`
Expand Down

0 comments on commit 979dd20

Please sign in to comment.