Flickshare App

The Flickshare App is directed for anyone who really has a hard time finding suggestions on what to watch next! The app allows users to create an account and custom lists of movie interests, which may then be used to generated a list of movie suggestions and store them for coming back to it later.

Working Prototype

User Stories

As a prospective user
- I am landed in the Welcome Page
- I can see the week's top movie suggestions per category
- I can navigate to the Register and Login pages
- I can see more information about a movie
As a registered user
- I can create and name a list
- I can search for a movie to select for a list
- I can search, edit and delete my list
- I can browse top public lists
- I can see more information about a movie
As an Admin
- I can see, edit and delete users
- I can see and add movies
- I can see, edit and delete lists
- I can reset user suggestion lists

Technology

Javascript, Node.js, Express.js, Knex.js, PostgreSQL, Mocha, Chai, Supertest, JWT, Helmet

Functionality

The app's functionality includes:

Every User
- May create an account
- May browse public suggestion lists
- May read full movie information
Registered User
- May edit and delete their account
- May create, edit and delete their lists
- May generate suggestions from other lists
- May search for any movie
Admin
- May see a list of all users
  - May create, edit and delete any user
- May see a list of all lists
  - May create, edit and delete any list

Back-End Structure

Users (database table)
- user_id (integer, auto-generated)
- first_name (text, not null)
- last_name (text, not null)
- email (text, unique)
- username (text, unique)
- password (text, hashed)
- admin (boolean, default false)
Lists (database table)
- list_id (integer, auto-generated)
- name (text, not null)
- user_id (integer, optional)
Movies (database table)
- movie_id (integer, auto-generated)
- name (text, not null)
- tmdb_id (integer, id from tmdb API)
- description (text, maximum 150 characters)
- release_date (text, not date)
- popularity (numeric, decimal)
- poster (text, poster image URL)
- avg_vote (numeric)
- vote_count (integer)
List Movies (database table)
- list_id (references lists.list_id)
- movie_id (references movies.movie_id)

API Documentation

Endpoints that require Authentication

Closed endpoints that require a valid username and password to be included in the header body of the request.

Login

Step 1: (Generate JSON Web Token)
- POST /api/login
  - 'Admin' credentials
    - Username: admin
    - Password: password
Step 2: <Use generated JSON Web Token (3 hrs)>
Step 3 (Optional): Refresh JSON Web Token
- POST /api/token

Endpoints that require Authorization

Closed endpoints that require a valid JSON Web Token to be inlcuded in the header 'Authorization' of the request.

// Add to request header
headers: {'Authorization': 'Bearer <JSON Web Token>'}

If sending content through request body (POST), don't forget to add the following in the headers:

// Add to request header
headers" {'Content-Type': 'application/json'}

User related

Each endpoint manipulates information related to users.

Create User (Register): POST /api/users
Get User: GET /api/users/:user
Edit User: PATCH /api/users/:user
Delete User: DELETE /api/users/:user

Get Users

URL: /api/users
Method: GET
Auth required: Yes

Bearer my-secret-admin

Success Response

Code: 200 OK
Content example

[
  {
    "username": "dschrute",
    "first_name": "Dwight",
    "last_name": "Schrute",
    "email": "schrutefarms@creedmail.com",
    "admin": false
  },
      
  ...
]

Create User (Register)

URL: /api/users
Method: POST
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Request Body

Requires headers: {'Content-Type': 'application/json'}

  {
  "username": "rhoward",
  "password": "password",
  "first_name": "Ryan",
  "last_name": "Howard",
  "email": "commited@wuphf.com",
  "admin": false
}

Name	Type	In	Description
`username`	string	header	Unique username
`password`	string	header	User password
`first_name`	string	header	First name of user
`last_name`	string	header	Last name of user
`email`	string	header	User email
`admin`	boolean	header	Admin privileges

Success Reponse

Code: 201 Created
Content example

{
  "user_id": 4
  "username": "rhoward",
  "first_name": "Ryan",
  "last_name": "Howard",
  "email": "commited@wuphf.com",
  "admin": false
}

Edit User

URL: /users/:userID
Method: PATCH
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Request Body

Requires headers: {'Content-Type': 'application/json'}

{
  // All optional, at least one required.
  "username": "rhoward",
  "first_name": "Ryan",
  "last_name": "Kapoor", // Edited
  "email": "taken@wuphf.com", // Edited
  "admin": false
}

Name	Type	In	Description
`user`	integer	path	User ID
`username`	string	header	Unique username
`first_name`	string	header	First name of user
`last_name`	string	header	Last name of user
`email`	string	header	User email
`admin`	boolean	header	Admin privileges

Success Reponse

Code: 201 Created (Resource updated successfully, and refreshes.)
Content example

{
  "user_id": 4
  "username": "rhoward",
  "first_name": "Ryan",
  "last_name": "Kapoor",
  "email": "taken@wuphf.com",
  "admin": false
}

Notes

All values will be necessary in Update due to previous empty field validation

Delete User

URL: /users/:user
Method: DELETE
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Name	Type	In	Description
`user`	integer	path	User ID

Success Reponse

Code: 301 Moved Permanently
Content example

<No Content>

List related

Each endpoint manipulates information of general and user lists.

Get Main Lists: GET /api/lists/main
(General suggestion/category lists not associated to users)
Create List: POST /api/lists
Get List: GET /api/lists/:list
Edit List: PATCH /api/lists/:list
Delete List: DELETE /api/lists/:list

Movie related

Each endpoint manipulates information related to movie data.

Get All Movies: GET /api/movies
Add Movie to Database: POST /api/movies
Get Movie: GET /api/movies/:movie

Get All Movies

URL: /api/movies
Method: GET
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Success Reponse

Code: 200 OK
Content example

[
  {
    "movie_id": 1,
    "name": "Man of Steel",
    "description": "Come on, it's Man of Steel.",
    "tmdb_id": 99999,
    "releaste_date": 2013,
    "popularity": 987.72
    "avg_vote": 7.4,
    "vote_count": 9,876
    "poster": "https://image.tmdb.org/t/p/original/manofsteel.jpg",
  },
      
  ...
]

Get Movie

URL: /api/movies/:movie
Method: GET
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Success Reponse

Code: 200 OK
Content example

[
  {
    "movie_id": 1,
    "name": "Man of Steel",
    "description": "Come on, it's Man of Steel.",
    "tmdb_id": 99999,
    "releaste_date": 2013,
    "popularity": 987.72
    "avg_vote": 7.4,
    "vote_count": 9,876
    "poster": "https://image.tmdb.org/t/p/original/manofsteel.jpg",
  },
      
  ...
]

Add Movie to Database

URL: /api/movies
Method: POST
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Request Body

Requires headers: {'Content-Type': 'application/json'}

{
  "name": "The Dark Knight",
  "description": "No description necessary.",
  "tmdb_id": 99998,
  "release_date": 2008,
  "popularity": 985.27
  "avg_vote": 6.9,
  "vote_count": 8,517
  "poster": "https://image.tmdb.org/t/p/original/thedarkknight.jpg"
}

Name	Type	In	Description
`name`	string	header	Name of project
`description`	string	header	Description of project
`tmdb_id`	string	header	Languages/Tools required
`release_date`	string	header	Project Phase
`popularity`	string	header	Project Phase status
`avg_vote`	string	header	Creator of project
`vote_count`	string	header	Date created
`poster`	boolean	header	Accepts collaboration

Success Reponse

Code: 201 Created
Content example

{
  "movie_id": 2,
  "name": "The Dark Knight",
  "description": "No description necessary.",
  "tmdb_id": 99998,
  "releaste_date": 2008,
  "popularity": 985.27
  "avg_vote": 6.9,
  "vote_count": 8,517
  "poster": "https://image.tmdb.org/t/p/original/thedarkknight.jpg"
}

Add Movie to List

URL: /api/movies/lists/:list
Method: POST
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Request Body

Requires headers: {'Content-Type': 'application/json'}

{
  "movie_id": 1
}

Name	Type	In	Description
`list`	integer	path	List ID
`movie_id`	integer	header	Movie ID

Success Reponse

Code: 201 Created
Content example

<No Content>

Delete Movie

URL: /api/movies/:movie
Method: DELETE
Auth required: Yes

Bearer my-secret-admin

Name	Type	In	Description
`movie`	integer	path	Movie ID

Success Reponse

Code: 301 Moved Permanently
Content example

<No Content>

Delete List Movie

URL: /api/movies/:movie/lists/:list
Method: DELETE
Auth required: Yes

Bearer my-secret-admin
Bearer <JSON Web Token>

Name	Type	In	Description
`movie`	integer	path	Movie ID
`list`	integer	path	List ID

Success Reponse

Code: 301 Moved Permanently
Content example

<No Content>

Movie-List related

Each endpoint manipulates information related to the movies in lists.

Get List Movies: GET /api/movies/lists/:list
Add Movie to list: POST /api/movies/lists/:list
Delete Movie from list: DELETE /api/movies/:movie/lists/:list

Get All Lists

URL: /api/lists
Method: GET
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Success Response

Code: 200 OK
Content example

[
    {
    "list_id": "1",
    "name": "Admin list",
    "user_id": 1,
    "movies": [...]
  },
  {
    "list_id": "2",
    "name": "Top Rated",
    "user_id": null,
    "movies": [...]
  }
      
  ...
]

Get Main Lists

URL: /api/lists/main
Method: GET
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Success Response

Code: 200 OK
Content example

[
    {
    "list_id": "2",
    "name": "Top Rated",
    "user_id": null,
    "movies": [...]
  },
  {
    "list_id": "3",
    "name": "Popular",
    "user_id": null,
    "movies": [...]
  }
      
  ...
]

Create List

URL: /api/lists
Method: POST
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Request Body

Requires headers: {'Content-Type': 'application/json'}

{
  "name": "New List Name",
  "user_id": 1  // Optional
}

Name	Type	In	Description
`name`	string	header	Name of list
`user_id`	integer	header	Description of list

Success Response

Code: 201 Created
Content example

{
  "list_id": 3,
  "name": "New List Name",
  "user_id": 1
}

Edit List

URL: /api/lists/:list
Method: PATCH
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Request Body

Requires headers: {'Content-Type': 'application/json'}

{
  "name": "New Name"
}

Name	Type	In	Description
`list`	integer	path	List ID
`name`	string	header	Name of list

Success Response

Code: 201 Created (Resource updated successfully, and refreshes.)
Content example

{
  "list_id": 3,
  "name": "New Name",
  "user_id": 2
}

Notes

All values will be necessary in Update due to previous empty field validation

Delete List

URL: /api/lists/:list
Method: DELETE
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Name	Type	In	Description
`list`	integer	path	LIst ID

Success Response

Code: 301 Moved Permanently
Content example

<No Content>

Access / Token related

Each endpoint manipulates information related access / token management.

Login: POST /api/login
Register: POST /api/users
Refresh JWT Token: PATCH /api/token

Login

URL: /api/login
Method: POST
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin

####### Request Body

{
  "username": "admin",
  "password": "password",
}

Name	Type	In	Description
`username`	string	header	Unique username
`password`	string	header	User password

Success Response

Code: 200 OK
Content example

{
  "flickshareToken": &lt;JSON Web Token&gt;
}

Refresh Token

URL: /api/token
Method: GET
Auth required: Yes

Bearer <JSON Web Token>

Success Response

Code: 200 OK
Content example

{
  "flickshareToken": &lt;JSON Web Token&gt;
}

Registration

URL: /api/users
Method: POST
Auth required: Yes

Bearer my-secret-key
Bearer my-secret-admin
Bearer <JSON Web Token>

Request Body

Requires headers: {'Content-Type': 'application/json'}

{
  "username": "rhoward",
  "password": "password",
  "first_name": "Ryan",
  "last_name": "Howard",
  "email": "commited@wuphf.com",
  "admin": false
}

Name	Type	In	Description
`username`	string	header	Unique username
`password`	string	header	User password
`first_name`	string	header	First name of user
`last_name`	string	header	Last name of user
`email`	string	header	User email
`admin`	string	header	Admin privileges

Success Response

Code: 201 Created
Content example

[
  {
    "user_id": "4"
    "username": "rhoward",
    "first_name": "Ryan",
    "last_name": "Howard",
    "email": "commited@wuphf.com",
    "admin": false
  },
  
  ...
]

Admin related

Each endpoint manipulates information related to all data, only able to be accessed by an Admin user. Admins can manipulate all previous endpoints as well.

Get All Users: GET /api/users
Get All Lists: GET /api/lists

Development Roadmap

This is v1.0 of the app, but future enhancements are expected to include:

Implementation of movie likes
Implementation of list likes
Sending movie-list suggestions
Copy other user's lists

Local Dev Set Up

Start a database server with pg_ctl start.

If using user admin:

mv example.env .env
createdb -U admin flickshare
createdb -U admin flickshare-test

If your admin user has a password be sure to set it in .env for all appropriate fields. Or if using a different user, update appropriately.

npm install
npm run migrate
env MIGRATION_DB_NAME=flickshare-test npm run migrate

To start the application, use npm start. Tests will run automatically.
Alternatively, to run development mode, use npm run dev. Tests will not run.

To seed the database: psql -U admin -d flickshare -f ./seeds/seed.flickshare.sql.

And npm test should work at this point.

Configuring Postgres

For tests involving time to run properly, configure your Postgres database to run in the UTC timezone.

Locate the postgresql.conf file for your Postgres installation.
1. E.g. for an OS X, Homebrew install: /usr/local/var/postgres/postgresql.conf
2. E.g. on Windows, maybe: C:\Program Files\PostgreSQL\11.2\data\postgresql.conf
3. E.g on Ubuntu 18.04 probably: '/etc/postgresql/10/main/postgresql.conf'
Find the timezone line and set it to UTC:

# - Locale and Formatting -

datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
timezone = 'UTC'
#timezone_abbreviations = 'Default'     # Select the set of available time zone

Name		Name	Last commit message	Last commit date
Latest commit History 89 Commits
migrations		migrations
public		public
seeds		seeds
src		src
test		test
.gitignore		.gitignore
Procfile		Procfile
README.md		README.md
example.env		example.env
package-lock.json		package-lock.json
package.json		package.json
postgrator-config.js		postgrator-config.js

dionisggr/flickshare-api

Folders and files

Latest commit

History

Repository files navigation

Flickshare App

Working Prototype

API URL

Client Live:

Client GitHub:

User Stories

Technology

Functionality

Back-End Structure

API Documentation

Endpoints that require Authentication

Login

Endpoints that require Authorization

User related

Get Users

Success Response

Create User (Register)

Request Body

Success Reponse

Edit User

Request Body

Success Reponse

Notes

Delete User

Success Reponse

List related

Movie related

Get All Movies

Success Reponse

Get Movie

Success Reponse

Add Movie to Database

Request Body

Success Reponse

Add Movie to List

Request Body

Success Reponse

Delete Movie

Success Reponse

Delete List Movie

Success Reponse

Movie-List related

Get All Lists

Success Response

Get Main Lists

Success Response

Create List

Request Body

Success Response

Edit List

Request Body

Success Response

Notes

Delete List

Success Response

Access / Token related

Login

Success Response

Refresh Token

Success Response

Registration

Request Body

Success Response

Admin related

Development Roadmap

Local Dev Set Up

Configuring Postgres

About

Topics

Resources

Stars

Watchers

Forks

Languages