mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
a1ce89bedc
* fix: use the frontend dir from the backend * Build is now working * Fix workflows * Fix workflows * Fix build PRs * Test coverage workflow * Test coverage * Test coverage run * Fix jest report * refactor: add missing frontend build * refactor: ignore frontend dir for coverage * refactor: run frontend build in PRs * refactor: run backend tests in PRs * Revert "refactor: run backend tests in PRs" This reverts commit22cabddfd1. * refactor: remove unused frontend build file * refactor: test workflows in PR * refactor: use a prepare script for the frontend * refactor: simplify yarn build scripts * refactor: fix check-release script * Revert "refactor: test workflows in PR" This reverts commit496ae19404. * refactor: remove unused gitignore lines * refactor: remove renovate config from the frontend repo * refactor: remove frontend repo license * refactor: remove frontend repo changelog * refactor: update frontend repo readme * refactor: add frontend node_modules to dockerignore * refactor: update the docker yarn.lock snapshot Co-authored-by: olav <mail@olav.io>
69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
# frontend
|
|
|
|
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:
|
|
|
|
```
|
|
cd ~/frontend
|
|
yarn install
|
|
yarn run start
|
|
```
|
|
|
|
## Run with a heroku-hosted instance of unleash-api
|
|
|
|
Alternatively, instead of running unleash-api on localhost, use a remote instance:
|
|
|
|
```
|
|
cd ~/frontend
|
|
yarn install
|
|
yarn run start:heroku
|
|
```
|
|
|
|
## Running end-to-end tests
|
|
|
|
We have a set of Cypress tests that run on the build before a PR can be merged
|
|
so it's important that you check these yourself before submitting a PR.
|
|
On the server the tests will run against the deployed Heroku app so this is what you probably want to test against:
|
|
|
|
```
|
|
yarn run start:heroku
|
|
```
|
|
|
|
In a different shell, you can run the tests themselves:
|
|
|
|
```
|
|
yarn run e2e:heroku
|
|
```
|
|
|
|
If you need to test against patches against a local server instance,
|
|
you'll need to run that, and then run the end to end tests using:
|
|
|
|
```
|
|
yarn run e2e
|
|
```
|
|
|
|
You may also need to test that a feature works against the enterprise version of unleash.
|
|
Assuming the Heroku instance is still running, this can be done by:
|
|
|
|
```
|
|
yarn run start:enterprise
|
|
yarn run e2e
|
|
```
|
|
|
|
## Generating the OpenAPI client
|
|
|
|
The frontend uses an OpenAPI client generated from the backend's OpenAPI spec.
|
|
Whenever there are changes to the backend API, the client should be regenerated:
|
|
|
|
```
|
|
./scripts/generate-openapi.sh
|
|
```
|
|
|
|
This script assumes that you have a running instance of the enterprise backend at `http://localhost:4242`.
|
|
The new OpenAPI client will be generated from the runtime schema of this instance.
|
|
The target URL can be changed by setting the `UNLEASH_OPENAPI_URL` env var.
|