mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00

History

sjaanus d5e47ac352 formatApiPath / formatAssetPath - Implement smart functionality to detect double subpath (#2777 ) Today we have two functions that wrap our paths with the subpath. Since all of our customers are hosted on a subpath, such as /eubb1001, we need to account for this path when building API paths and asset paths. These functions could be smarter, we could, for example detect if we have already added the base path and ignore it if it already exists. This PR implements this and adds 2 capabilities: 1. If there is list of paths that need to be joined and one is subset of another, it is removed. 2. All duplicate paths in the list are removed		2023-01-02 12:06:33 +02:00
..
cypress	Remove full width access tab (#2679 )	2022-12-13 13:41:40 +02:00
public
scripts
src	formatApiPath / formatAssetPath - Implement smart functionality to detect double subpath (#2777 )	2023-01-02 12:06:33 +02:00
.editorconfig	add editorconfig	2016-12-05 23:08:32 +01:00
.gitignore
.nvmrc
.prettierignore
.prettierrc
cypress.json
index.html	ui flags replaced in index.html (#2617 )	2022-12-07 14:31:27 +02:00
index.js
package.json	fix: add frontend eslint check (#2562 )	2023-01-02 10:46:32 +01:00
README.md
tsconfig.json
tsconfig.node.json
vercel.json	fix: update vercel proxy paths (#2623 )	2022-12-07 13:00:51 +01:00
vite.config.ts	fix: allow import @server (#2601 )	2022-12-05 16:21:59 +00:00
yarn.lock	chore(deps): update dependency vitest to v0.26.3 (#2788 )	2023-01-01 19:36:10 +00:00

README.md

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 sandbox instance of the Unleash API

Alternatively, instead of running unleash-api on localhost, you can use a remote instance:

cd ~/frontend
yarn install
yarn run start:sandbox

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:sandbox

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.