viveksoundrapandi / byor-voting-server

BYOR-VotingApp [server]

Welcome to the repository for the server component of BYOR-VotingApp!

You can find more information about the BYOR-VotingApp in the web-app Github repository.

Running API server locally

1. install Docker
2. open the terminal
3. clone the project

   git clone https://github.com/thoughtworks/byor-voting-server.git

4. move into the project folder

   cd byor-voting-server

5. startup web app, server, and a local MongoDB

   docker-compose up

6. access the API on http://localhost:3000

Please refer to CONTRIBUTING.md for more options on running the server locally and connect to a MongoDB database.

Running BYOR-VotingApp on Kubernetes

Please refer to BYOR-VotingApp [infrastructure] Github repository for installing the application on Kubernetes.

How to contribute to the project

Please refer to CONTRIBUTING.md for all the information about how to contribute.