Skip to content

Commit

Permalink
update readme for better instructions on how to run locally
Browse files Browse the repository at this point in the history
  • Loading branch information
devksingh4 committed Oct 10, 2024
1 parent ab091f7 commit fd78273
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Example ACM@UIUC Node-based API using AWS Lambda/API Gateway
# ACM @ UIUC Core API

## Run Locally
1. `yarn -D`
2. `make check_account_dev` - If this fails make sure that AWS is configured.
3. `make local`
1. Copy `.env.sample` as `.env` and set the `JwtSigningKey` to a random string.
2. Enable Tailscale VPN so you can reach the development database in AWS
3. Log into AWS with `aws configure sso` so you can retrieve the AWS secret and configuration.
4. `yarn -D`
5. `make check_account_dev` - If this fails make sure that AWS is configured.
6. `make local`

## Build for AWS Lambda
1. `make clean`
Expand All @@ -17,7 +20,7 @@

## Generating JWT token

Create a `.env` file containing your `CLIENT_SECRET`.
Create a `.env` file containing your `AadClientSecret`.

```bash
node --env-file=.env get_msft_jwt.js
Expand Down

0 comments on commit fd78273

Please sign in to comment.