apps/: contains all deployables; contains all services of the FleetData application as well as services for testing, monitoring and local developmentenv/: environement configuration files for local/test/int/prod deploymentsscripts/: usefull scripts for common tasksdocker-compose.yaml: use this compose configuration to start the application locallyPasswords.kdbx: KeePass encrypted Password-Database containing all relevant passwords
There is a docker-compose.yaml file that can be used to deploy the service locally.
Build and deploy by running following commands in the root directory.
docker-compose up --build
To remove the local services with all data use
docker-compose down -v
Each service is documented in its own README.
The App is divided into a frontend and a backend. They are deployed to Heroku automatically if the CI is done and all tests pass.
- Frontend: https://unia-se-teamcq-cns-frontend.herokuapp.com/
- Backend: https://unia-se-teamcq-cns-backend.herokuapp.com/
- Api-Mock: https://unia-se-teamcq-apimock-backend.herokuapp.com/
When first accessing those services, there might be a short delay, as Heroku has to spin them up first.
- Stefan Grafberger (Team leader)
- Fiona Guerin
- Maximilian Kuschewski
| Technologies | Selection |
|---|---|
| Language (Backend) | Kotlin |
| Web Framework | Spring Boot |
| Build Tool | Gradle |
| ORM | Hibernate |
| Database Migration | Flyway |
| Job Scheduling | Quartz |
| API Client Generation | OpenAPITools |
| DTO & Entity Mapping | MapStruct |
| Unit Testing | https://github.com/kotlintest/kotlintest |
| Mocking | https://mockk.io/ |
| IDE | IntelliJ IDEA |
| UI Prototyping | Figma |
| Issue Tracking | Github |
| Code Style / Linter | https://github.com/shyiko/ktlint |
| Language (Frontend) | Typescript & React |
| Frontend State | Redux |
| Frontend Testing | Jest, Snapshots & Selenium |
- Create issues for everything
- Create branches for issues
- Name branches for issues:
[issue-nr]-[short-description] - Rebase and squash before merging
- Before merging any branches into
master: Two people have to review the code. - Create code, code documentation and issues in English
- Reference the respective issue when creating a pull request
- Mockup: https://www.figma.com/file/eoajJpSOmiDUlgJLYVdil0/Notification-Service-Mockup?node-id=29%3A211
In apps/customisable-notification-service-backend
- Unix:
./gradlew bootRun - Windows: use gradlew.bat
Starting a development environment for the frontend with auto reloading and more can be done using:
cd apps/customisable-notification-service-frontend
yarn install
yarn start