https://github.com/steveoversea/storefront-backend
Udacity Full Stack Javascript Project: PostgreSQL managed API with user authentication and JWTs.
https://github.com/steveoversea/storefront-backend
jwts nanodegree-fullstackjavascript postgres-database
Last synced: about 1 month ago
JSON representation
Udacity Full Stack Javascript Project: PostgreSQL managed API with user authentication and JWTs.
- Host: GitHub
- URL: https://github.com/steveoversea/storefront-backend
- Owner: SteveOverSea
- License: other
- Created: 2021-05-10T07:19:22.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-24T11:20:14.000Z (almost 4 years ago)
- Last Synced: 2025-01-31T06:48:55.404Z (3 months ago)
- Topics: jwts, nanodegree-fullstackjavascript, postgres-database
- Language: TypeScript
- Homepage:
- Size: 212 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Storefront Backend Project
This project is part of the Udacity Full Stack JavaScript Nanodegree.
The task was to implement a API for a FrontEnd Application describend in REQUIREMENTS.md
It should showcase following functionality:
- setting up postgreSQL database in Node.js
- up/down migrations with db-migrate
- handling the structure between database models, route handlers and http verbs
- follwing a test driven development approach with jasmine and supertest
- password hashin with bcrypt
- json web tokens for protecting routes (JWT)
## Setup
### PostgreSQL
Make sure that you habe PostgreSQL installed, otherwise install [PostgreSQL](https://www.postgresql.org) from their homepage.
```
postgres --version
```
Start Postgres with
```
(sudo) su - postgres
```
and enter the Postgres terminal with
```
psql postgres
```
(you have to enter your superuser and postgres password)
Create the database
```
CREATE DATABASE ;
```
Create a user and grant access to this database
```
CREATE USER WITH PASSWORD '';
GRANT ALL PRIVILEGES ON DATABASE TO ;
```
Connect to the database
```
\c
```
Display the tables (no relations should be found)
```
\dt
```
Now that you can create a database and a user, you should create one database (with a user) for production and one database (with a user - you can use the same as for the dev db) for testing.
The project will work with your database if you name your environment variables in the .env file (from [dotenv](https://www.npmjs.com/package/dotenv)) accordingly:
```
DB_HOST = ""
DB_NAME = ""
DB_USER = ""
DB_PASSWORD = ""
TEST_DB_NAME = "" (for tests)
```
Other environment variables that are necessary
```
ENV = "dev" (decided to run with dev db or test db)
BCRYPT_PW = ""
SALT_ROUNDS = ""
TOKEN_SECRET = ""
PROJECT_PATH = ""
```
Install the node modules
```
npm install
```
Load the database schema with
```
db-migrate up
```
Run the test suite with
```
npm run test-up
```
and afterwards reset the test-database with
```
npm run test-down
```
you can start this API with
```
npm run start
```
The server runs on localhost:3000 on default.
## Routes and Database Schemas
Show and Index routes never require a token.
Create, Update and Delete routes usually do.
### /users
The user consists out of
- id
- first_name
- last_name
- password
- recentPurchases (optional)
Creating the user doesn't need a token.
You can login with your credentials on /users/login
The passwords gets hashed with bcrypt.
On the Show route (GET users/:id) you also get recentPurchases back, an array of max. 5 Products the user recently ordered.
### /products
The product consists out of
- id
- name
- price
- category
The usual CRUD routes are implemented, you need a user token for all manipulating routes.
### /orders
The order consists out of
- id
- user_id
- status
The order stores orders connected to a specific users and saves the current status (active or finished).
The usual CRUD routes are implemented, you need a user token for all manipulating routes.
### /order_lists
The order consists out of
- id
- order_id
- quantity
- product_id
The order_lists stores the products and quantity connected to a specific order.
The usual CRUD routes are implemented, you need a user token for all manipulating routes.