Giter Site home page Giter Site logo

courageous-trapeze's Introduction

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
  • Scrum Master: Kevin Huang
  • Development Team Members: Melanie Gin, Mike Harris, Kevin Huang, John Yeglinski

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.

courageous-trapeze's People

Contributors

kevhuang avatar onelovelyname avatar

Watchers

James Cloos avatar  avatar

courageous-trapeze's Issues

Set up server

  • Set up server to host entire app (3) - Melanie
    • Node and Express
    • Set up route for / to serve up index.html
    • Set up additional API routes for communicating with the mobile app (request all messages for given user for day, update database with all messages sent/rejected for that day) (/api/user, /api/messages, etc)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.