Backend for Backpack App (W9 Project)

This is the repo for our server and database, where we have built the API routes, postgresql queries and tests. Our API CRUD routes are connected to our database (Heroku) and the data is fed to our frond end via the GET routes.

Description

Backpack is the name of our project and we were aiming to build a Social app with some productivity features (such as note taking and progress tracker).

Features of MVP

• Read User details
• Create Skills and Goals
• Update Skills and Goals
• Delete Skills and Goals

Link to Frontend

API Reference

PORT Used: 3001

User

Method	Path	Additional Info	Result	Response
GET	/user		all user	{ success: True, payload: User array }

Skills

Method	Path	Additional Info	Result	Response
GET	/skills		all skills	{ success: True, payload: Skills array }
POST	/skills	[{ details: String, complete: Boolean, notes: String }]	create a new skill	{ success: True, payload: new skills was added to database }
PUT	/skills/<skills_id>	{ details: String, complete: Boolean, notes: String }	updated skill by ID	{ success: True, message: You've updated a skill, payload: Updated skill }
DELETE	/skills/<skills_id>		delete skill by ID	{ success: True, payload: The skills with id: <skills_id> has been deleted }

Goals

Method	Path	Additional Info	Result	Response
GET	/goals		all goals	{ success: True, payload: Goals array }
POST	/goals	[{ title: String, star: Number, notes: String }]	create a new goal	{ success: True, payload: new goals was added to database }
PUT	/goals/<goals_id>	{ title: String, star: Number, notes: String }	updated goal by ID	{ success: True, message: You've updated a goal, payload: Updated goal }
DELETE	/goals/<goals_id>		delete goal by ID	{ success: True, payload: The goal with id: <goals_id> has been deleted }

Tech Stack

Database: Heroku

Server: Node, Express, Jest, Nodemon, Supertest, pg

Running Tests

To run tests, run the following command

  npm run test

Run Locally

Clone the project

  git clone https://github.com/SchoolOfCode/w9_backend-project-team-js

Install dependencies

  npm install

Start the server

  npm run dev

Database Documentation

Create .env file

PGPORT=<Your database port>
PGHOST=<Your database host>
PGDATABASE=<Your database reference>
PGUSER=<Your database username>
PGPASSWORD=<Your database password>

Run these scripts to create the tables on your database:

User

    npm run db:dropUserTable
    npm run db:createUserTable
    npm run db:popUserTable

Skills

   npm run db:dropSkillsTable
   npm run db:createSkillsTable
   npm run db:popSkillsTable

Goals

   npm run db:dropGoalsTable
   npm run db:createGoalsTable
   npm run db:popGoalsTable

Authors

• @Steven Cheung

• @Claudia Gonzalez-Casales

• @Adam Phasey

• @Skandog