Setup & Development

Getting Started

Preparation:

Install Node.js (preferably using NVM).
Clone this repository.
Execute nvm use to enable the correct Node version.
Execute npm install to install the dependencies.
Copy public/settings.example.js to public/settings.js and adjust its contents.
You're good to go 🚀

Start the development server:

npm start

The application is then running on http://localhost:3000.

To be able to log in with the test users you have to be in a trusted IP range or the OAuth provider requires 2FA to login (i.e. you can't log in).

Build the project:

npm run build

The build artifacts will be stored in the dist/ directory.

You can also visualize the contents of the generated bundle by running:

npm run analyze

Verify TypeScript typing and check source files with ESLint:

npm run lint

Print a report of unused dependencies, files & exports using Knip (for the configuration, see .knip.json):

npm run unused

Run E2E tests interactively:

npm run cy:open

Run E2E tests headless:

npm run cy:run

For more information, see Cypress.