communikey frontend

communikey (frontend)

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

This repository is the frontend part of the communikey application. If you want to run communikey yourself, follow the setup guide of both repositories

Prerequisites

You will need the following things setup & ready for communikey-frontend to work:

• npm
• Node.js

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.

• Move into the project root folder

• execute npm install & wait for the process to finish

• execute npm run dev

• Please note that, if you are planning to run the whole application (front&backend). Start the backend first, otherwise the node process will steal the backend port.

• For setup of the backend, see the corresponding repository here

Running tests

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

• npm run test

• To update the snapshots, which tests are run against run npm run test:watch and press u

Versioning

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

Built With

• React - Javascript library
• Ant Design - UI library
• npm - Node package manager

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.