Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
b4eed811a1
unleash.unleash/frontend
History
Fredrik Strand Oseberg b4eed811a1 fix: update favicon path to CDN (#896) 
* fix: update favicon path to CDN

* docs:set favicon path to use cdnPrefix

* fix: update favicon path to use prefix
2022-05-02 23:37:52 +02:00
..
.github/workflows refactor: convert auth tests from Cypress to Jest (#864) 2022-04-08 13:13:45 +02:00
cypress chore: update MUI to v5 (#923) 2022-05-02 15:52:41 +02:00
public fix: update favicon path to CDN (#896) 2022-05-02 23:37:52 +02:00
scripts feat: generate an OpenAPI client (2) (#875) 2022-04-26 10:53:46 +02:00
src chore: update MUI to v5 (#923) 2022-05-02 15:52:41 +02:00
.editorconfig add editorconfig 2016-12-05 23:08:32 +01:00
.gitignore Ignore .env.local 2021-10-11 14:50:48 +02:00
.nvmrc chore: update .nvmrc (#870) 2022-04-08 11:56:37 +02:00
.prettierignore feat: generate an OpenAPI client (2) (#875) 2022-04-26 10:53:46 +02:00
.prettierrc refactor: format files (#719) 2022-02-18 09:51:10 +01:00
CHANGELOG.md Chore/update frontend 4.2.13 (#503) 2021-11-12 13:24:41 +01:00
cypress.json refactor: fix flaky Cypress tests (#746) 2022-02-25 10:21:28 +01:00
index.js fix: expose unleash-frontend version in index.js (#661) 2022-04-08 11:45:23 +02:00
LICENSE fix: license year to 2020 2020-05-12 22:40:05 +02:00
package.json chore(deps): update material-ui monorepo 2022-05-02 17:08:58 +00:00
README.md feat: generate an OpenAPI client (2) (#875) 2022-04-26 10:53:46 +02:00
renovate.json chore: uopdate renovate config 2021-09-29 21:15:15 +02:00
tsconfig.json feat: add baseUrl to tsconfig and update imports 2022-02-20 21:08:02 +01:00
typings.json Feat/material UI (#250) 2021-03-30 15:14:02 +02:00
vercel.json fix: reject duplicate segment names (#855) 2022-04-08 11:34:59 +01:00
yarn.lock chore(deps): update material-ui monorepo 2022-05-02 17:08:58 +00:00

README.md

unleash-frontend

This repo 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 unleash-frontend dev server:

cd ~/unleash-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 ~/unleash-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.