Skip to content

Commit

Permalink
docs: update guides
Browse files Browse the repository at this point in the history
  • Loading branch information
nunogois committed May 11, 2023
1 parent 2a4ff80 commit 1bbc488
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
7 changes: 3 additions & 4 deletions frontend/README.md
Expand Up @@ -4,13 +4,12 @@ This directory contains the Unleash Admin UI frontend app.

## Run with a local instance of the unleash-api

First, start the unleash-api backend on port 4242.
Then, start the frontend dev server:
Refer to the [Contributing to Unleash](../CONTRIBUTING.md#how-to-run-the-project) guide for instructions.
The frontend dev server runs simultaneously with the backend dev server:

```
cd ./frontend
yarn install
yarn run start
yarn dev
```

## Run with a sandbox instance of the Unleash API
Expand Down
10 changes: 5 additions & 5 deletions website/docs/contributing/backend/overview.md
Expand Up @@ -20,7 +20,7 @@ Before developing on this project you will need two things:

```sh
yarn install
yarn run start:dev
yarn dev
```

## PostgreSQL {#postgresql}
Expand Down Expand Up @@ -65,14 +65,14 @@ In order to start the application you will need Node.js v14.x or newer installed
// Install dependencies
yarn install
// Start server in development
yarn start:dev
// Start Unleash in development
yarn dev
// Unleash UI
http://localhost:4242
http://localhost:3000
// API:
http://localhost:4242/api/
http://localhost:3000/api/
// Execute tests in all packages:
yarn test
Expand Down

0 comments on commit 1bbc488

Please sign in to comment.