Reference Links

App Deployment
policies and procedures
Build week Schedule and Daily Milestones
Rubric (Also see "Project Scores 1/2/3" below)
List of Projects

Tech Stack

git - Command line tool used for version control.
github - Webhosting site for containing repositories and supporting git commands.
Javascript - Language/Files used.
Node - Shorthand for NodeJS,
Nodemon - Used for Development: Identifies changes made to your code upon saving, and restarts the server.
Express - Sets up your index/server, middleware, routes, and endpoints.
Morgan - Logging system for console logging things ran on backend.
Helmet - Hides your techstack in the header front end.
Cors - allows multiple outside connections to get access via different url/ports.
knex - Handles Migration Tables, Seeds, Creates database file through client, provides query methods for server endpoints.
sqlite3 - Generates Local Database File.

Project Summary

As a researcher, it's difficult to keep track of articles you want to read later. Pintereach helps you research by enabling you to save and organize articles in to categories to read later.

/Endpoints (For Frontend Usage)

Global CRUD Rules

GET: Always Returns Array
Requires AUTHENTICATION: Valid Token passed in Header
Response Returns: if the value of the key(in the object) is empty, an empty string "" will be returned as the key's value { key: "" }

/auth

POST /auth/register

Example: Send

const newUser = {
  username: "jamespage", // (Unique) required
  display_name: "RandomBlogger", // optional
  password: "pass123", // required
  email: "[email protected]", // (Unique) optional
  img_url: "https://i.imgur.com/mACq7e7.jpg" // optional
}

axios.post('https://pintereach.herokuapp.com/auth/register', newUser)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example: Returned

[
  {
    id: 1,
    token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NCwidXNlcm5hbWUiOiJqYW1lc3BhZ2UyIiwiaWF0IjoxNTQ5NTU5MDU0LCJleHAiOjE1NDk2NDU0NTR9.7nb3JixZBBFJy9583qRMuteylu60dkVKJFFY99v0Qcg"
  }
]

POST /auth/login

Example: Send

const creds = {
  username: "jamespage", // required
  password: "pass123" // required
}

axios.post('https://pintereach.herokuapp.com/auth/login', creds)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example: Returned

[
  {
    message: "Logged in",
    token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NCwidXNlcm5hbWUiOiJqYW1lc3BhZ2UyIiwiaXNfYWRtaW4iOjAsImlhdCI6MTU0OTU1OTEzMSwiZXhwIjoxNTQ5NjQ1NTMxfQ.29FwqKW_0ETCpNiSrwV1U5lSUHdlf3nfoFtp_-wbyiM"
  }
]

/users

GET /users Requires AUTHORIZATION

Explanation: returns all users

Example: Send

const headersObj = {
  headers: { authorization: token }
};

axios.get('https://pintereach.herokuapp.com/users', headersObject)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

example: Receive

[
  {
    id: 1,
    display_name: "RandomBlogger" // display_name value will be username if display name is empty
  },
  {
    id: 2,
    display_name: "catperson" // display_name value will be username if display name is empty
  },
  {
    id: 3,
    display_name: "reader" // display_name value will be username if display name is empty
  }
]

GET /users/:id Require AUTHORIZATION AND AUTHENTICATION(admin and/or self-user only)
Explanation: returns single user

Rule: User is only able to view user attributes if they belong to user logged in. Admin can view user attributes of any user.

Example: Send

const headersObj = {
  headers: { authorization: token }
};

axios.get(`https://pintereach.herokuapp.com/users/${1}`)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example1: Receive (if not admin)

[
  {
      "id": 3,
      "username": "reader",
      "display_name": "reader",
      "email": null,
      "img_url": null
  }
]

Example2: Receive (if admin)

[
  {
    "id": 4,
    "is_admin": 0,
    "username": "jamespage2",
    "display_name": "RandomBlogger2",
    "email": null,
    "img_url": null
  }
]

GET /users/:id/articles

Explanation: Returns a single user with all articles

Example: Send

const headersObj = {
  headers: { authorization: token }
};

axios.get(`https://pintereach.herokuapp.com/users/${1}/articles`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

example: Receive

{
  "id": 1,
  "display_name": "RandomBlogger",
  "articles": [
    {
      "id": 1,
      "user_id": 1,
      "cover_page": "https://coverpage1.com/",
      "title": "Hello World",
      "link": "https://helloworld.com/",
      "categories": [
        {
          "id": 1,
          "name": "General"
        },
        {
          "id": 3,
          "name": "Other"
        }
      ]
    },
    {
      "id": 2,
      "user_id": 1,
      "cover_page": "https://i.imgur.com/zbg9mtf.png",
      "title": "Lambda Strikes Down Students With New Build Week",
      "link": "",
      "categories": [
        {
          "id": 2,
          "name": "Lambda Times"
        }
      ]
    },
    {
      "id": 3,
      "user_id": 1,
      "cover_page": "",
      "title": "Deadlines — Bad reason for bad code.",
      "link": "https://medium.com/mindorks/deadlines-bad-reason-for-bad-code-d3d5fe22f3ff",
      "categories": [
        {
          "id": 1,
          "name": "General"
        }
      ]
    }
  ]
}

Post /users/articles Requires AUTHORIZATION
Explanation: add article to your user board

Rule: Can only add articles on your own user boards... not other use boards (this includes admins)

Example1: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    cover_page: "https://coverpage1.com/", // optional, requires at least 1
    title: "Hello World", // optional, requires at least 1
    link: "https://helloworld.com/", // optional, requires at least 1
    category_ids: [ 1, 3 ] // optional
  }
};

axios.post(`https://pintereach.herokuapp.com/users/articles`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example2: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    "title": "Deadlines — Bad reason for bad code.",
    "link": "https://medium.com/mindorks/deadlines-bad-reason-for-bad-code-d3d5fe22f3ff"
  }
};

axios.post(`https://pintereach.herokuapp.com/users/articles`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example: Receive

[
  {
      "id": 94
  }
]

Post /users/:id/categories Requires AUTHORIZATION and AUTHENTICATION
Explanation: Creates a category

Rule: user_id must match the user :id in the axios url

Example: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    user_id: 1,
    name: "New Category"
  }
};

axios.delete(`https://pintereach.herokuapp.com/users/${1}/categories`, headersObj)
  .then(response => {
    console.log(response.data);
  })
  .catch(err => console.log(err));

Example: Received

[
  {
      "id": 4
  }
]

PUT /users/:id Requires AUTHORIZATION and AUTHENTICATION
Explanation: edit any user key/value pairs (including password)
Note: Only SAME USER or ADMIN can change the user attributes (not other users)

Note2: DO NOT include is_admin property in the headersObj, or it will set it to false.

Example1: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    username: "catperson", // required (username cannot be changed)
    password: "$his1sMuchBetter#$%", // optional (new password)
    email: "[email protected]" // optional
  }
};

axios.put(`https://pintereach.herokuapp.com/users/${2}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example2: Send

const headersObj = {
  headers: { authorization: token },
  data: {
      username: "catperson", // required (username cannot be changed)
      email: "[email protected]", // optional
      img_url: "https://proxy.duckduckgo.com/iu/?u=http%3A%2F%2Fwww.pethealthnetwork.com%2Fsites%2Fdefault%2Ffiles%2Fcontent%2Fimages%2Fhow-tell-if-your-cats-secretly-sick-fb-179022698.jpg&f=1"
  }
};

axios.put(`https://pintereach.herokuapp.com/users/${2}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

example: Receive


[
  {
    'Users Changed': 1
    message: "changes successful"
  }
]

PUT /users/:userid/articles/:id Requires AUTHORIZATION
Explanation: edits the article that belongs to the user
Rule: You must be the owner of the article or an admin to edit it

Rule2: If you provide the categories array, you must ALSO provide the category_id's that were already stored in the backend IF YOU WANT TO KEEP THEM. (examples: current -> changes -> result... ([1, 3] -> [2] -> [2]) || ([1,3] -> [1,2,3] -> [1,2,3]))

Example1: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    cover_page: "Test", // Optional (at least 1)
    title: "Test", // Optional (at least 1)
    link: "Test", // Optional (at least 1)
    category_ids: [1, 3] // Optional
  }
};

axios.delete(`https://pintereach.herokuapp.com/users/${UserID}/articles/${ArticleID}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example2: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    cover_page: "Testing", // Optional (at least 1)
    title: "Testing", // Optional (at least 1)
    link: "Testing", // Optional (at least 1)
  }
};

axios.delete(`https://pintereach.herokuapp.com/users/${UserID}/articles/${ArticleID}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example1: Receive

[
  {
    "numOfarticlesChanged": 1,
    "numOfCategoriesRemoved": 2,
    "numOfcategoriesAdded": 2,
    "message": "Article/Categories with id '10' was successfully changed"
  }
]

Example2: Receive

[
  {
    "numOfarticlesChanged": 1,
    "numOfCategoriesRemoved": 0,
    "numOfcategoriesAdded": 0,
    "message": "Article/Categories with id '10' was successfully changed"
  }
]

DELETE /users/:id Requires AUTHORIZATION
Explanation: remove your own user account from the database

Note: Only SAME USER or ADMIN can delete the user account (not other users)

Example: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    password: "$his1sMuchBtter643" // required
  }
};

axios.delete(`https://pintereach.herokuapp.com/users/${2}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

example: Receive

[
  {
    'Users Deleted': 1,
    message: "user was successfully removed"
  }
]

DELETE /users/:userid/articles/:id' Requires AUTHORIZATION
Explanation: remove a single article from the user board

Note: Can only delete an article belonging to your own user account (unless you are admin)

Example: Send

const headersObj = {
  headers: { authorization: token }
};

axios.delete(`https://pintereach.herokuapp.com/users/${userId}/articles/${articleId}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

example: Receive

[
  {
    "articlesDeleted": 1,
    "message": "Article was successfully removed"
  }
]

Categories

GET /categories Requires AUTHORIZATION

Explanation: Returns the names of all the articles

Example: Send

const headersObj = {
  headers: { authorization: token }
};

axios.delete(`https://pintereach.herokuapp.com/categories`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example: Received

[
  {
      "name": "General"
  },
  {
      "name": "Lambda Times"
  },
  {
      "name": "Other"
  }
]

GET /categories/:id Requires AUTHORIZATION
Explanation: Returns the category details

Rule: The user_id is only returned if the user is an admin.

Example: Send

const headersObj = {
  headers: { authorization: token }
};

axios.delete(`https://pintereach.herokuapp.com/categories/2`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example1: Recieve

[
  {
    "id": 2,
    "user_id": 2,
    "name": "Lambda Times"
  }
]

Example2: Recieve

[
  {
    "id": 2,
    "name": "Lambda Times"
  }
]

PUT /categories/:id Requires AUTHORIZATION and AUTHENTICATION
Explanation - removes categories and the relationships they have to articles on user boards

Rule: Only admins can edit categories

Example: Send

const headersObj = {
  headers: { authorization: token },
  data: {
    "name": "Change name here"
  }
};

axios.delete(`https://pintereach.herokuapp.com/categories/2`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

const headersObj = {
  headers: { authorization: token },
  data: {
    "name": "Change name here"
  }
};

axios.delete(`https://pintereach.herokuapp.com/categories/${id}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example: Receive

[
  {
    "categoriesChange": 1,
    "message": "Category name 'Change name here' with id '3' was successfully changed"
  }
]

DELETE /categories/:id Requires AUTHORIZATION and AUTHENTICATION
Explanation - removes categories and the relationships they have to articles on user boards

Rule: Only admins can delete categories (since they are shared accross user boards)

Example: Send

const headersObj = {
  headers: { authorization: token }
};

axios.delete(`https://pintereach.herokuapp.com/categories/${:id}`, headersObj)
  .then(response => {
    console.log(response.data)
  })
  .catch(err => console.log(err));

Example: Receive

[
  {
      "categoriesDeleted": 1,
      "message": "Category was successfully removed"
  }
]

Table Schema

users

Field	Data Type
id	Int (auto increment)
is_admin	boolean (optional) (default false)
username	String (unique) (required)
display_name	String (optional)
password	String (required)
email	String (optional)
img_url	String (optional)

articles

Field	Data Type (requires at LEAST title OR link)
id	Int (auto increment)
user_id	Foreign Key (points to id of users table)
title	String (optional1)
cover_page	String (optional2)
link	Text (optional3)

articles_categories_relationship

Field	Data Type
id	Int (auto increment)
articles_id	Foreign Key (points to id of articles table)
categories_id	Foreign Key (points to id of categories table)

Project Scores 1/2/3

https://docs.google.com/spreadsheets/d/1sFgvt8HtqNCw32YC8Wvrgrdb61oEWPTsBUrvOL3rAGQ/edit#gid=0

MVP work - Project should incorporate all of the listed MVP features

Student did not achieve all of the MVP features of the project.
Student's work demonstrates that all MVP features were built
Student's work demonstrates that all MVP features were built and the student went above and beyond the project.

Team contribution

Little to no contributions were made by this team member.
Team member was collaborative, able to work in a team environment
Pair programmed with the Web UI and Web Architect

Me and Jeff did zoom chats over the weekend (before project starting day on Monday)
Student should have built a CRUD API using Node/Express

Student did not build a CRUD API with all of the required endpoints, or the endpoints that exist don't work
Student built a CRUD API using Node and Express, code is clean and organized.
Student built a CRUD API using Node and Express, code is clean and organized. Student organized code using a patern similar to MVC, the usage of Routes and controllers and middleware is present and property incorperated throughout the project's backend

Data model is normalized

Student created a data model that exhibits data repetition and does not take advantage of foreign key constraints.
Student built a normalized data model where each entity is tracked in it's own table and where appropriate made use of Foreign Key constraints to ensure data integrity and consistency.
Student incorporated Knex migration and or seeding scripts to their solution.

The API incorporates authentication

Student did not add a way to authenticate users and restrict access to endpoints to only logged in users.
Student added authentication and restricted endpoints to be accessible only by logged in users.
Student added authorization and a way to restrict endpoints to users with that are authorized to access them. This could be as simple as using roles and restricting endpoints to a particular role.

Project has automated testing suites covering Endpoints and Business Logic

The solution does not have any automated testing in place.
The core business logic is tested using unit tests.
The project has unit and integration tests that include end to end testing using a test database.

API is deployed to the web

The API is not deployed and only runs on localhost.
The API is deployed on the web and can be accessed from anywhere, but the deployment is done manually.
The project has continuous deployment configured to deploy on commits to GitHub

Secrets are protected using environment variables

Any secrets like API keys and hashing secrets are hard-coded in the source code
Secrets are extracted out into environment variables using .env files that most be manually changed when deploying.
The project is configured to dinamically load the appropriate secrets based on the environment it's running on.

Name		Name	Last commit message	Last commit date
Latest commit History 85 Commits
data		data
middleware		middleware
public		public
servers		servers
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
doc.html		doc.html
index.js		index.js
knexfile.js		knexfile.js
package.json		package.json
yarn.lock		yarn.lock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Table of Contents

Reference Links

Tech Stack

Project Summary

/Endpoints (For Frontend Usage)

Global CRUD Rules

Table Schema

users

articles

categories

articles_categories_relationship

Project Scores 1/2/3

About

Uh oh!

Releases

Packages

Contributors 2

Uh oh!

Languages

Field	Data Type
id	Int (auto increment)
user_id	Int (Required) (Unique)
name	String (Required) (Unique)

License

jamespagedev/Pintereach

Folders and files

Latest commit

History

Repository files navigation

Table of Contents

Reference Links

Tech Stack

Project Summary

/Endpoints (For Frontend Usage)

Global CRUD Rules

Table Schema

users

articles

categories

articles_categories_relationship

Project Scores 1/2/3

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Uh oh!

Languages

Packages