The UI part of the system that intends to provide user-friendly wrapper over the API in order to easily do common things: signin/signup, create API tokens, use graphql playground, explore data stored in the database.
- Install project dependencies via
npm install - Start development server via
npm run dev - View hot-reloaded UI on http://localhost:3000
Please refer to the root readme to learn more about general development setup.
API_ORIGIN(optional, default/api): relative path or the url under whichapiservice is running. For example, if theapiservice is running on port 4000, the value should behttp://localhost:4000. However, if theapiis sharing the origin with thefrontendservice via reverse-proxy, providing relative path is enough (e.g.:/api)
You can build application for production using npm run build and then locally preview production build via npm run preview.
Endpoint available at /healthz path. Provides response if frontend is currently running.
One of the frontend's features is displaying the documentation about document model. The documentation is provided to the service externally as raw typedoc output in markdown format.
To display the documentation on the frontend the provided data has to be processed and represented in the form of a single file.
TODO: add the precise process in separate issue