Florgs helps you blarbing the faghtah' by shlorping the caboole.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- Java > 9 (we recommend using sdkman to manage your Java installations)
- Docker (18.09.3 is known to work)
- Run the build
mvn package - Start the app
java -jar target/florgs.jar -v
This should display $ Florgs v0.0.2.
Unit tests are located in src/test/....
Unit tests may not talk to other services, access the network or the file system,
Call mvn test -Punit to run the tests.
Integration tests are located in src/test/....
Integration tests are allowed to talk to the database and the message queue.
The connection properties are specified in the environment:
FLORGS_DB_URL, e.g.jdbc:postgresql://localhost:3306/myDbFLORGS_DB_USER- `...``
To run the required services in docker just say docker-compose up to provision an environment
that works with the default test profile.
Call mvn test -Pintegration to run the tests.
E2E tests are implemented using Cypress in src/test/frontend.
cd src/test/frontend
npm install
npx cypress open
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE.md file for details