Giter Club home page Giter Club logo

ambiguous-cicada's Introduction

Stories in Ready

Kwiki

Kwiki is a mobile chat app that brings closeby users together.

Refer to our API Documentation for internal details of our app.

Original Kwiki Team

  • Product Owner: Daniel O'Leary
  • Scrum Master: JT Knox
  • Development Team Members: Niraj Vora, Michael Junio, Daniel O'Leary, JT Knox

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Tasks
  4. Contributing

Usage

Config

The config file located at env/config.js contains environment variables that can be set to your requirements and process.env.NODE_ENV will be used to determine which set of variables will be used. Find more information in the API Documentation.

Server

The server is in NodeJS and is configured to start with node server/server.js or simply npm start from the root directory.

Client

API Keys and public DB_URI

The Google geocoding API-key and the public Mongo-lab URI are all stored in .env, which is .gitignored. The variables in .env can be manually added to the production server with $ heroku config. To access the the .env file with process.env in development mode, you must start the development server with $ heroku local.

Requirements

  • Node 0.12.7
  • npm
  • MongoDB
  • Ionic

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Known bugs and issues

This project contains known bugs and issues, which can all be accessed here. Feel free to add to them.

Potential new features

  • Geolocation using device GPS
  • Location based restaurant/bar suggestions
  • Post emoji, images, video, location, etc
  • Allow multiple chats per client
  • Group chats with more than two users

Contributing

See the Contribution Guidelines in CONTRIBUTING.md for a detailed explanation of our contribution protocol.

ambiguous-cicada's People

Contributors

mikejune avatar dkoleary88 avatar zeke avatar jtknox91 avatar hunterloftis avatar hackreactor-students avatar jonmountjoy avatar raul avatar samccone avatar theneva avatar friism avatar r0mdau avatar waffle-iron avatar

Watchers

James Cloos avatar  avatar

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.