Adds an example date as a detail of the locale picker, so that the user can see what effect their chosen locale would have on date formatting: <img width="436" height="157" alt="image" src="https://github.com/user-attachments/assets/d5757380-3cda-4857-99d7-bac8866d31f5" /> The example wraps on smaller screens: <img width="291" height="207" alt="image" src="https://github.com/user-attachments/assets/e3ef1678-6846-4027-b563-253195e2de99" /> The example date is the **date and time of the very first commit in the Unleash repo**. By some stroke of luck, it happens to have everything we're looking for: - A date that is more than the 12th (to clearly differentiate between days and months) - A month that is less than 10 (to show whether leading zeroes are shown or not) - An hour that is more than 11 to show whether it's a 24-hour clock or an AM/PM system The date string is without a time zone offset because that means it'll always be interpreted as local time for the user. MDN's [docs on Date and what happens when you call it with a time string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format) state that: > When the time zone offset is absent, date-only forms are interpreted as a UTC time and **date-time forms are interpreted as a local time**. I've checked this by changing my locale. With the timezone offset, the time changes based on my timezone, but without it, it always shows as the expected value. |
||
---|---|---|
.. | ||
.yarn/releases | ||
cypress | ||
public | ||
scripts | ||
src | ||
.editorconfig | ||
.gitignore | ||
.npmignore | ||
.nvmrc | ||
.yarnrc.yml | ||
check-imports.rc | ||
cypress.config.ts | ||
cypress.d.ts | ||
index.html | ||
index.js | ||
mise.toml | ||
orval.config.ts | ||
package.json | ||
README.md | ||
tsconfig.json | ||
tsconfig.node.json | ||
vercel.json | ||
vite.config.mts | ||
yarn.lock |
frontend
This directory contains the Unleash Admin UI frontend app.
Run with a local instance of the unleash-api
Refer to the Contributing to Unleash guide for instructions. The frontend dev server runs (in port 3000) simultaneously with the backend dev server (in port 4242):
yarn install
yarn dev
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:
For now we only use generated types (src/openapi/models). We will use methods (src/openapi/apis) for new features soon.
yarn gen:api
rm -rf src/openapi/apis
clean up src/openapi/index.ts
imports, only keep first line export * from './models';
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.
Analyzing bundle size
npx vite-bundle-visualizer
in the root of the frontend directory