Need a last-minute date idea? We've got you covered.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dateClient
dateServer
.bowerrc
.gitignore
.travis.yml
Deployment-and-Database.md
LICENSE
Procfile
README.md
_CONTRIBUTING.md
_STYLE-GUIDE.md
bower.json
gulpfile.js
package.json

README.md

Need a last-minute date idea? We've got you covered. Check it out at dateworthy.io

Build Status

Table of Contents

  1. Team
  2. Usage
  3. Requirements
  4. Development
    1. Installing Dependencies
  5. Product-Roadmap
  6. Contributing
  7. Testing
  8. Resources

Team

Usage

  • Please read the deployment guide! Even if you are not interested in deploying the app, there's a tremendous amount of information on how to seed databases and get your local dateworthy up and running!
  • Please read the contribution guide. There's a wealth of client and server tests at your disposal, and any pull request made to dateworthy must pass continuous integration tests before it can be merged.

Requirements

  • neo4j v2.2.5
  • npm 2.14+
  • bower 1.6.5+

Development

You will need a populated neo4j database. To seed your local neo4j database with dateworthy data, navigate from the root directory to /dateServer/data-helpers/ and run:

node seedAllLocal.js

Make sure to point the server to your local neo4j database at /dateServer/models/db.js to populate it with some seed data. The default local installation will start neo4j at port 7474.

Installing Dependencies

From within the root directory:

sudo npm install

From within the dateServer/ directory

sudo npm install

Our npm install command also includes a postinstall script that runs bower install, so you don't need to manually run bower install yourself.

Product-Roadmap

This project was a labor of love. The dateworthy team, The Nefarious Chickens, are hoping to bring some of these features in the future:

  • A welcome back workflow to like dates you've already seen
  • Foursquare auth to avoid rate limits on venues returned
  • The ability to submit ideas through the app
  • Date reviews and a date idea community
  • Troll mode to give people absurd date ideas
  • Infrastructure improvements, more tests, and other things we haven't thought of!

Contributing

See CONTRIBUTING.md for contribution guidelines.

Testing

Dateworthy uses test suites written in Mocha, Karma, Chai and Jasmine. On every pull request, the tests are automatically run using Travis continuous integration. To run the test suites locally, use the following command from your route directory:

npm test

Resources

Some resources that helped us start this project include: