bibbycodes / rate-my-cat

Robert Griffith - ClearBank Solution

An app where you can rate random cat images from 0 - 5

Usage | Planning | CI/CD | Tests | Extending

Click here to use the app

Usage

Clone this repo.

Install Packages:

npm install && cd client && npm install

Create DB and tables:

Type in psql into the command line Create the database:

CREATE DATABASE cats;

Next add the table:

CREATE TABLE ratings (
  id SERIAL PRIMARY KEY,
  rating INTEGER NOT NULL,
  url VARCHAR(4000) NOT NULL,
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

Make sure you have a .env file in the root directory with the following configuration:

API_KEY=<YOUR_API_KEY>
NODE_ENV=development
DB_NAME=cats
DB_USER_LOCAL=<YOUR_POSTGRES_USERNAME>

Planning

Before I started implementing the solution I spent some time writing user stories and planning:

As a cat enthusiast
So I can pass the time
I want to see a picture of a random cat

As a user
So I can share my opinion
I would like to rate a cat image

As a user
So I can keep looking at cats
I would like to see a different cat image

As a cat person
So I can look at the cutest cats
I want to view the leaderboard

I then broke the user stories into tasks with acceptance criteria. The details of which can be found in Trello Board

Tests

To run the tests simply enter npm run test into the console. This will provide test results.

  Rating
    ✓ retrieves all ratings for an image
    ✓ adds a ratings to the db (90ms)
    ✓ retrieves all ratings

  server routes
    server routes
      ✓ returns 50 results when hitting /cats (831ms)
      ✓ returns 1 result when hitting /cats/random (543ms)


  5 passing (2s)

CI/CD

I used Travis CI for continuous integration. This meant that I was confident that all tests were passing and that branches were safe to merge. The app is then deployed automatically to Heroku if tests pass on the master branch.

Extending

If I had more time I would have added styles to the page. I would have preffered to use mongoDB or another noSQL database since there are no relations in the tables. I attempted to deploy to AWS using terraform but I didnt have enough time to fully implement that, so I opted for Heroku instead. I would have also liked to add unit tests for my react components. Additionally, it would have been good to write some logic to ensure that the average rating is displayed in the leader boards. As it stands if the same image is rated twice, it will show up twice in the leaderboards.