Need a new recipe? Maybe some ideas on what to wear to work? What color should you paint your bedroom? Let’s create a platform that allows you to keep all of your inspiration in one place.
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
log
public
spec
tmp
vendor/assets
.gitignore
.rspec
.travis.yml
Gemfile
Gemfile.lock
README.md
Rakefile
authorizations_summary.png
config.ru
dashboard.png
database_diagram.png
home.png
user.png

README.md

README

Outline

  1. Overview of Pinspiration
  2. Website Preview
  3. Setup Instructions
  4. Deployment Instructions
  5. How to Run the Test Suite
  6. Team Members

Overview of Pinspiration

A Pinterest clone in two weeks!

Website Preview

The following screen shots provide a brief visual of the appearance and functionality of the application. The full website is deployed on Heroku and accessible via this link: https://pinspirations.herokuapp.com/

Home Page

alt text

Dashboard Page

alt text

User Page

alt text

Database Diagram

alt text

User Authorizations Summary

alt text

Authorization Notes:

  • Admin authorizations apply to all users’ content, including boards tagged as private.
  • Admins are not able to delete users, but they are able to take them offline under necessary circumstances, rendering their user profile inactive and preventing anyone from accessing content created by the innactive user.
  • Registered user authorizations apply only to content that is self-created or shared by other users. Registered users are able to read all public boards, pins, and comments, and they are also able to read private boards, pins, and comments that are shared with them by the owner.
  • User account information is only available to the owner and admins. Passwords are encrypted and never viewed by admins.

What to Expect When Consuming the API

  • All endpoints will return JSON data
  • All endpoints are exposed under an api and version (v1) namespace (e.g. /api/v1/pins/pin_id/comments.json)

Setup Instructions

Run these commands in this order:

git clone https://github.com/CPowell23/pinspiration.git
cd pinspiration
bundle
rails db:create
rails db:migrate
rails db:seed
rails db:test:prepare

Deployment Instructions

To launch the project on local host, start up the rails server and...

rails s

API Routes Available

Comments

  • get /api/v1/pins/:id/comments?api_key=YOUR_API_KEY - returns a collection of comments associated with that pin
  • get /api/v1/pins/:id/:comment_id?api_key=YOUR_API_KEY - returns one comment with that :comment_id
  • post /api/v1/pins/:id/comments?api_key=YOUR_API_KEY - returns a collection of invoices associated with that merchant from their known
  • put /api/v1/pins/:id/:comment_id'?api_key=YOUR_API_KEY - edits a comment associated with that :comment id, send the comment.content through the params[:body]
  • delete /api/v1/pins/:id/:comment_id?api_key=YOUR_API_KEY - will delete a comment associated with that :comment_id

How to Run the Test Suite

Run rspec from the command line:

rspec

Team Members

Group Members

Back to Top