- Docker Desktop 4.10.* or higher or a local nodejs and npm installation
- Go into
app/backend
and runnpm install
thennpm run dev
- Go into
app/frontend
and runnpm install
thennpm run start
This will start both apps in the development mode (using hot reload and less ts compiler optimization, as well as more logging).
The Frontend will be available at http://localhost:3000/
and the backend at http:/localhost:5000/
- Go into the root directory and run
docker composer up -d
The development processes will be started automatically for you as long as the containers are running.
Both parts (frontend, backend) can use a hotloading feature (automatically started, when using docker) that allows development without constant restarts. ReactJS supports Hotloading out of the box. The Backend uses nodemon to detect and apply changes.
- Fork the repository
- Open a feature branch in your child repository (to maintain consistency, use git flow or similar)
- Make and commit your changes -> please do your fellow coders a favour and use semantic commit messages
- Repeat step 3
- Finish your feature branch
- Open a pull request for your changes in the main repository
- Remember to drink water, stay hydrated!
- Go to step 2
- After your feature has been merged into the main repository, create a new version tag and merge the new state into the main branch
- tbd
- Whenever possible, use class components
- Place scss files next to its component and give it the same filename (excluding the extension)