yongsu-l / mafia

1 stars 1 forks source link

Mafia

One Paragraph of project description goes here

Getting Started

WIP

Prerequisites

Nodejs
NPM

Installing

First navigate into mafia/backend

cd Backend

And install the necessary Dependencies

Using npm install

Create a .env file in this directory with the link to your Mongodb database

DB_URL=mongodb://username:password@url:port/db_name

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

Contributing

Versioning

Authors

License

Acknowledgments