Skip to content

REST API for a web application that allows friends/significant others to track who decided what to eat.

Notifications You must be signed in to change notification settings

mjmeli/whodecidesfood-api

Repository files navigation

whodecidesfood-api

Build Status

REST API for WhoDecidesFood, a web application that allows users to track who decides food as a competition. This is a Ruby on Rails application designed to be used as a REST API and the server for the static front-end content.

See the whodecidesfood-app repo for the front-end.

Team

  • Michael Meli
  • Kylie Geller

Local Environment Setup

Using Ubuntu 16.04:

Install git

sudo apt-get install git

Install ruby dependencies

sudo apt-get install git-core curl zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev python-software-properties libffi-dev libpq-dev ruby-rspec-core

Install ruby using rbenv (copy and paste these commands, except potentially updating the version of ruby)

cd
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
exec $SHELL

git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
exec $SHELL

rbenv install 2.6.3
rbenv global 2.6.3
ruby -v

Install bundler

gem install bundler
rbenv rehash

Install a JavaScript runtime, i.e. NodeJS. Use the latest version in the curl below.

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs

Install rails

gem install rails -v 5.0.0.1

Install postgres and create a user with your login name

sudo apt-get install postgresql postgresql-contrib
sudo -u postgres createuser --superuser YOUR_LOGIN_NAME

Clone repo

git clone https://github.com/mjmeli/whodecidesfood-api.git
cd whodecidesfood-api

Install gems

bundle install --without production

Development

To start the server

rails server

To run tests

rspec

Clearing and seeding database

rails db:migrate:reset
rails db:seed

API Documentation

After running the development server as described above, navigate to:

http://localhost:3000/apipie

Alternatively, navigate to the production API documentation:

http://www.whodecidesfood.com/apipie

About

REST API for a web application that allows friends/significant others to track who decided what to eat.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages