[go: up one dir, main page]

Skip to content

dfds/selfservice-portal

Repository files navigation

Self Service Portal

This is the frontend part of the self-service platform.

How to run

  1. Begin by renaming src/.env.local to src/.env.

We recommend using the provided Makefile targets, though if you're an npm ninja then you do you.

This react app depends on having an API running behind it. The UI will in theory run fine without one, but you'll see error banners and errors in your console if you do so. This will make it generally less pleasant to use, expecially if you want to debug changes you're working on.

Local instance of the real api

This is the method we prefer. Start a local instance of the self-service api. The default port it starts on is 8080.
In the file src/.env, add/change the following line

REACT_APP_API_BASE_URL=http://localhost:<port_where_the_api_is_exposed_on>

Then, to start the app run

make dev

if you want to check whether your project has any JavaScript/TypeScript warnings, you can also run make build instead.

Workflow and formatting

  • we use prettier for formatting
  • This project uses a lighter version of the classic git master/develop/feature/hotfix workflow. We try to have a 1-1 mapping of features (= feature branches) to issues on this board, and try to keep feature branches as limited in scope as possible. We make PRs into develop and have automatic mergeing from develop into master every once in a while.