Skip to content

Commit

Permalink
docs: update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
vplasencia committed Jan 23, 2024
1 parent 614d426 commit 279705a
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 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,26 @@ or the following command to start the applications in production mode:
yarn start
```

### Application urls

#### Development environment

Bandada API: http://localhost:3000
Bandada Dashboard: http://localhost:3001
Bandada Client App: http://localhost:3002

#### Production environment

Bandada API: https://api.bandada.pse.dev
Bandada Dashboard: https://bandada.pse.dev
Bandada Client App: https://client.bandada.pse.dev

#### Staging environment

Bandada API: https://api-staging.bandada.pse.dev
Bandada Dashboard: https://staging.bandada.pse.dev
Bandada Client App: https://client-staging.bandada.pse.dev

### Building libraries/applications

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

0 comments on commit 279705a

Please sign in to comment.