Skip to content

Commit

Permalink
Merge pull request #359 from privacy-scaling-explorations/docs/readme
Browse files Browse the repository at this point in the history
Update readme file
  • Loading branch information
vplasencia authored Jan 23, 2024
2 parents 614d426 + 5c82787 commit 3c1103b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,14 @@ cd bandada && yarn

## 📜 Usage

### Copy the API environment variables

Run this command to copy the [environment variables used by the API](https://github.com/privacy-scaling-explorations/bandada?tab=readme-ov-file#environment-variables):

```bash
cp apps/api/.env.example apps/api/.env
```

### Starting applications

Run the following command to start the applications in a development environment:
Expand All @@ -204,6 +212,14 @@ or the following command to start the applications in production mode:
yarn start
```

### Application urls

| App | Development | Production | Staging |
| ------------------ | --------------------- | ------------------------------ | -------------------------------------- |
| Bandada API | http://localhost:3000 | https://api.bandada.pse.dev | https://api-staging.bandada.pse.dev |
| Bandada Dashboard | http://localhost:3001 | https://bandada.pse.dev | https://staging.bandada.pse.dev |
| Bandada Client App | http://localhost:3002 | https://client.bandada.pse.dev | https://client-staging.bandada.pse.dev |

### Building libraries/applications

Run the following command to build the libraries/applications:
Expand Down

0 comments on commit 3c1103b

Please sign in to comment.