Awesome Open Source
Awesome Open Source

communikey

A simple, centralized, teambased, cross-platform credential manager using GPG encryption.

Prerequisites

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

Getting Started

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.

Running tests

  • Move into the project root folder and run the following command

  • mvn integration-tests

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the GPLv3 license see the LICENSE.md file for details.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Java (710,532
Spring Boot (12,331
Rest Api (8,177
Password Manager (742
Gpg (328
Password Store (186
Related Projects