Keepr API
Switch branches/tags
Nothing to show
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/tasks
public
scripts
spec
.editorconfig
.gitignore
.remarkrc
.rubocop.yml
.ruby-version
CONTRIBUTING.md
Gemfile
Gemfile.lock
Keepr_-_Page_1.png
LICENSE
README.md
Rakefile
STYLE.md
config.ru

README.md

Keepr API

A back-end client built using Rails and PostgreSQL for Keepr, a list app for keeping track of all the things you want to try. Includes Authentication.

API is hosted on Heroku at https://cryptic-fjord-23153.herokuapp.com/

** ERD ** ERD Please note: 'Must-Try' Attribute has not yet been added to 'Category_Contents.' It will be added soon.

Authentication

Verb URI Pattern Controller#Action
POST /sign-up users#signup
POST /sign-in users#signin
PATCH /change-password/:id users#changepw
DELETE /sign-out/:id users#signout

Categories

** Please Note: Users are only permitted to access and modify their own categories. **

Verb URI Pattern Controller#Action
GET /categories categories#index
GET /categories/1 categories#show
POST /categories categories#create
PATCH /categories/1 categories#update
DELETE /categories/1 categories#destroy

Things

Verb URI Pattern Controller#Action
GET /categories/1/things things#index
GET /things/1 things#show
POST /categories/1/things things#create

Category Contents

(Join Table between Things and Categories)

** Please Note: Users are only permitted to access and modify their own categories' contents. **

Verb URI Pattern Controller#Action
GET /category_contents/1 category_contents#show
POST /category_contents category_contents#create
PATCH /category_contents/1 category_contents#update
DELETE /category_contents/1 category_contents#destroy