/room8

Primary LanguageJavaScript

Room8

Description

Decision making app for roommates, friends, or whatever. Anonymous, easy and fast. Web application supports the creation of multiple polls that use the Borda Count method to rank options.

Application has built in Mail Gun API to allow admin to recieve updates

DEMO

Demo of Room8 Application

Project Setup

  1. Fork this repo
  2. Clone to your machine

Getting Started

  1. Update the .env file with your correct local information
  2. Install dependencies: npm i
  3. Fix to binaries for sass: npm rebuild node-sass
  4. Run migrations: npm run knex migrate:latest
  • Check the migrations folder to see what gets created in the DB
  1. Run the seed: npm run knex seed:run
  • Check the seeds file to see what gets seeded in the DB
  1. Run the server: npm run local
  2. Visit http://localhost:8080/

Contributing

  1. Add new remote as the master branch $ git remote add absolute-master https://github.com/jelocodes/room8
  2. Pull from master to get latest stable version before working git pull absolute-master
  3. Checkout and switch to a new branch named as the feature you're working on get checkout -b pwn-noobs
  4. Do local tests
  5. Push to your forked copy's branch on Github (not absolute-master) git push origin pwn-noobs
  6. Open pull request
  7. Wait for merge

Dependencies

  • Node 5.10.x or above
  • NPM 3.8.x or above