README.md

Project Klaus

A privacy preserving and decentralised(ish) secret santa.

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

Project Klaus is a web application to facilitate pairing people for secret santa. It uses a semi decentralised model, where almost all data is kept on the client and the server merely facilitates communication.

The algorithm used is based off of the one described in this article.

Built With

• Express.js
• React

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

Installation

1. Clone the repo

git clone https://github.com/ejstuart/project-klaus.git

2. Install NPM packages

npm install

Usage

npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

Jackson Chadfield

Eric Stuart

Acknowledgements

• Rodrigo Setti for the article he wrote on Cryptographic Secret Santa that inspired this project.