/partyof4

Primary LanguageJavaScriptMIT LicenseMIT

build status

Party Of 4

A social dining app where you can find open seats at nearby restaurants. Meet new people & eat great food!

Team

Table of Contents

  1. Team
  2. General
  3. Usage
  4. Requirements
  5. Development
    1. Installing Dependencies
    2. Running the server
    3. Seeding Test Data
    4. Roadmap
  6. Contributing

General

PartyOf4 is a social dining app combining meeting new people with eating at great restaurants. We use the Foursquare API to supply a list of nearby venues to users so they can create and join events where they can grab a bite with others.

This repo is for running the server, and you can see the source for our native iOS app (built in React Native) here.

Usage

Please feel free to contribute to the project or submit a bug or feature request as an issue.

Requirements

  • Node 0.10.x
  • PostgreSQL
  • Foursquare API key (as environment variables or hardcoded into server/config.js)

Development

Please checkout our internal API documentation here.

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Running the server

From within the root directory:

grunt build

You can also run tests with 'grunt test'.

Seeding Test Data

Seeding data will automatically happen in grunt build, but you can also run the following from within the root directory:

node TestData/makeData.js [drop existing tables (true/false)] [# of users]

Optional arguments are for whether to drop all tables prior to seeding, the number of users and events to create.

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.