Gazelle User Management User interface

This project is using Next.js v.14, React, Typescript and TailwindCSS technologies.

This project needs to be used with the Gazelle User Management back-end service.

Configurations

Install dependencies

npm install

Environment variables

You need to create a .env file at the root of the project and fill it with the following variables:

Start application in dev mode

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000/gum-ui with your browser to see the result.

Build docker image

docker build -t rg.fr-par.scw.cloud/gazelle-snapshot/app/gazelle-user-management-ui:${APP_VERSION} .

Start application

docker-compose up -d

Execute tests

End to end tests

The end to end tests are using Cypress.

You can open the Cypress test runner with the following command at the root of the project:

npx cypress open

[WARNING] The application must be started before running the tests.

Unit tests

The unit tests utilize React Testing Librairy and Jest.

They are located in the __tests__ folder containing both the unit tests and their associated snapshots.

To execute the tests and view the test coverage report, run:

npm test

If changes occur and you need to update the snapshots, run:

npm test -- -u

Learn More

To learn more about Next.js, take a look at the following resources:

Last updated