Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.16 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.16 KB
Raw

antiSocialite v0.0.1

antiSocialite allows you to schedule SMS communications with your closest contacts.

Table of Contents

  1. Usage
  2. Team
  3. Requirements
  4. Development
    1. Installing Dependencies
    2. Roadmap
  5. Contributing

Usage

As of v0.0.1, the product is composed of two UIs—the web app and the mobile app (Android). The web app is used to view and add contacts, as well as to view and schedule messages. The mobile app is used to retrieve scheduled messages for the day and to send the messages.

Team

  • Product Owner: Melanie Gin, Kurt Bartholomew
  • Scrum Master: Kevin Huang, Mark Bennett
  • Development Team Members: Melanie Gin, Mike Harris, Kevin Huang, John Yeglinski, Vivek Tumrukota, Steven Shyun

Requirements

  • Node 0.12.0
  • MongoDB 2.6.9+

Development

Google Account

In order to enable the Google contacts import, a Google account, Google Contacts API key, and Google Client ID are required. Details on how to set up all these components can be found on the Google Contacts API page.

Once you have your own Google API key and Google Client ID, set them in the Contacts factory in factories.js.

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Build

From within the root directory, compile all the necessary files using Grunt:

grunt

To have Grunt automatically watch and re-compile files upon change, use:

grunt watch

Run

From within the root directory, launch the MongoDB daemon and the server:

mongod (or sudo mongod)
node server.js

Navigate to http://localhost:3000 in your browser.

Roadmap

View the project roadmap here

Deployment

Make sure there is an environment variable for DATABASE_URL on the host that specifies the URL of your MongoDB instance.

Contributing

See CONTRIBUTING.md for contribution guidelines.