Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 1.37 KB

README.md

File metadata and controls

61 lines (37 loc) · 1.37 KB
Raw

Bears-Team-17

Voyage-7 | https://chingu.io/

Getting Started

clone the repo then npm install followed by npm run dev

Prerequisites

  • Node 8.11
  • mongodb 3.6

Installation

  1. clone repo
  2. copy dotenv sample file
  3. install packages (client & server)
  4. seed db
  5. run dev

Running the Tests

Create a .env.test file:

  1. cp sample.env .env.test
  2. change NODE_ENV to test
  3. change mongodb uri (optional)

Run tests: npm run test:fe

Deployment

TODO CI

Contributing

currently, push branches to repo. Default branch develop. CI runs off master to heroku.

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

Versioning

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

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc