/Swick

Primary LanguageJavaScript

SWICK

Team

  • Product Owner: Patrik Korzinski (@pkorzinski)
  • Scrum Master: Roni Vegh (@formatted)
  • Development Team Members: Jason Holtkamp (@holtkam2) Jeff Bernstein (@jeff-bernstein)

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Starting/Testing
    3. Tasks
    4. Deployed
  4. Team
  5. Contributing
  6. Other

Usage

Swick is an app that can help you get to the content you need on the internet much faster. Set up your own buttons to open several tabs with a single click. Configure interest feeds to get the latest info aggregated and streamed to your home page. Also, get friendly greeting dependant on time of day, and your location. This also allows for an overview of your local weather, as well as time of sunset/sunrise depending on current time of day. The SentiBar close to the bottom of the page uses machine learning to analyze the content of financial and global news over the last hour and displays it in a dynamic infographic. And there is still so much more coming! But we are careful to not add anything distracting or that doesn't add actual value or insight for the user. Clean and efficient is the approach to style.

Requirements

node 6.7.0 and npm need to put a .env file in root with the below structure run npm start

PORT=
STORMPATH_CLIENT_APIKEY_ID=
STORMPATH_CLIENT_APIKEY_SECRET=
STORMPATH_APPLICATION_HREF='https://api.stormpath.com/v1/applications/'
DATABASE_URL='postgres://'
WATSON_TONE_URL=
WATSON_TONE_PASSWORD=
WATSON_TONE_USERNAME=
WATSON_ALCHEMY_URL='https://gateway-a.watsonplatform.net/calls'
WATSON_ALCHEMY_APIKEY=
DARKSKY_APIKEY=
DARKSKY_URL='https://api.darksky.net/forecast/'
YQL_APIKEY=
YQL_SECRET=
GOOGLE_MAPS_APIKEY=
OPENWEATHER_APIKEY=

Development

Installing Dependencies

To install all the node dependencies

npm install

Starting/Testing

To start the node server

npm start

To run the linter and tests

npm test

Tasks

View the waffle.io issue here

Deployed

Swick is currently deployed on heroku at swick.herokuapp.com API keys on the deployed site may not work reliably after 2016-11-01.

Contributing

See CONTRIBUTING.md for contribution guidelines.

Other

The style guide for this project is from airbnb, see STYLE-GUIDE.md