A simple, centralized, teambased, cross-platform credential manager using GPG encryption.
You will need the following things setup & ready for communikey-backend to work:
If you need a detailed guide on how to setup a new user & database follow this link
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
-
Clone the project using your favorable way of cloning a github project.
-
Setup a database preferably named "communikey", with a password & username of your choice. See prerequisites for detailed notes.
-
Edit application-dev.yml in the /src/main/resources folder to reflect your new database, password & username you just created.
-
Move into the project root folder and start it with maven
-
mvn spring-boot run -
Please ensure that port 8080 is free, since its used by the application.
-
Move into the project root folder and run the following command
-
mvn integration-tests
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Spring Boot - The application framework used
- Maven - Dependency Management
Read the contributing guide to learn about the development process and how to propose enhancement suggestions and report bugs, how to submit pull requests and the project's styleguides, branch organization and versioning model.
The guide also includes information about minimal, complete, and verifiable examples and other ways to contribute to the project like improving existing issues and giving feedback on issues and pull requests.
This project is licensed under the GPLv3 license see the LICENSE.md file for details.