Backend for Nectar app
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
public
spec
vendor/assets
.env.local
.gitignore
.projections.json
.pryrc
.ruby-version
.travis.yml
Gemfile
LICENSE
Procfile
README.md
Rakefile
config.ru

README.md

Build Status Dependency Status

Nectar Backend

Backend for Nectar app

Copyright © 2017 The PSU CS Beeminder Capstone Team

Remade and maintained by: Teal Dulcet

Adapted from Gal Tsubery's Quantifier.

Nectar adds support for more integrations on Beeminder. Automatically gets data from supported integrations and adds it to Beeminder goals.

Available for testing at: https://beemindernectar.herokuapp.com/.

Requires Ruby 2.3 or greater, Rails 5.0.0.1 or greater and PostgreSQL 9.1 or greater. Must set all environment variables listed in: .env.local.


Table of Contents


Idea

The idea behind the Nectar Backend is to provide a server for the Nectar Frontend Mobile app, that integrates naturally with the Beeminder website.

Usage

This app allows the user to do the following things for their Beeminder account

  • View a Goal
  • Add integration to a goal

Supported Integrations

The Nectar Backend supports the following integrations:

  • Beeminder
  • Austin Bcycle
  • Bitbucket
  • Blogger
  • Dropbox
  • Evernote
  • Facebook
  • Fitbit
  • Flickr
  • GitHub
  • Gmail
  • Google Calendar
  • Google Drive
  • Google Fit
  • Google+
  • Google Tasks
  • Instagram
  • KhanAcademy
  • LinkedIn
  • Microsoft Office365
  • Moves
  • Pocket
  • Quizlet
  • Remember The Milk
  • RunKeeper
  • Slack
  • Stack Overflow
  • Strava
  • Trello
  • Tumblr
  • Twitter
  • Typeracer
  • Wikipedia
  • World Community Grid
  • Wunderlist
  • YouTube

Most of these integrations do not yet have metrics to track.

Build

The following instructions will enable you to download and compile the source into a working server:

  1. Install Ruby: https://www.ruby-lang.org/en/documentation/installation/
    1. Requires Ruby 2.3 or greater (because of this: https://en.wikipedia.org/wiki/Safe_navigation_operator#Ruby).
    2. Note: If you are using Windows, we highly recommend you use Bash on Windows 10 (https://msdn.microsoft.com/en-us/commandline/wsl/install_guide) and then follow the Linux instructions. If you install on windows, use the RailsInstaller to install Ruby, Rails and Bundler: http://railsinstaller.org/en. Here are some links to help solve some of the problems you may encounter:
      1. http://stackoverflow.com/a/35730896
      2. http://blog.cloud-mes.com/2014/08/19/how-to-install-gem-curb-in-windows/
      3. http://curl.haxx.se/dlwiz/?type=lib&os=Win32&flav=-
    3. Note: If you are using Linux and your package manager provides an older version, you can use the Ruby Version Manager: https://rvm.io/.
  2. Install Rails: http://guides.rubyonrails.org/getting_started.html#installing-rails and Bundler
    1. Requires Rails 5.0.0.1 or greater.
  3. Install PostgreSQL: https://devcenter.heroku.com/articles/heroku-postgresql#local-setup
    1. Requires PostgreSQL 9.1 or greater.
  4. Setup PostgreSQL by opening the GUI.
  5. Clone or Download the files: https://github.com/beeminder-capstone/Nectar-Backend and CD into the directory.
  6. Set all environment variables listed in: .env.local.
    1. The bottom six are required.
    2. Get the SECRET_KEY_BASE by running: rake secret.
  7. Run: bundle install. (On Windows or Mac, follow the instructions on the top of this file to install the pg gem: config/database.yml.)
    1. Note: If you are using Windows, you must set a System Environment Variable:
      1. Open “This PC” and find the installation folder for PostgreSQL. Mine was C:\Program Files\PostgreSQL\9.6.
      2. Open “This PC” > “Properties” > “Advanced system settings”, click “Environment Variables”.
      3. Under “User variables”, select the Path Variable, click “Edit…” > “New”. Type the path from step a + \bin.
  8. Run: rake db:create and rake db:migrate.
  9. Start the server: bin/rails server (on Windows: ruby bin\rails server).
  10. Go to: http://localhost:3000/.

Contributing

To contribute, simply fork and then create a pull request.

License

Copyright © 2017 The PSU CS Beeminder Capstone Team

Originally made by:

This code is available under the "MIT License". Please see the file LICENSE in this distribution for license terms.