gdngothehieu / Udacity_store_front_backend

#GET_PASSES_THIS_REPO_UDACITY_PLEASE

Storefront Backend Project

Getting Started

This repo contains a basic Node and Express app . To get started, clone this repo and run npm i in your terminal at the project root.

Your application must make use of the following libraries:

• Postgres for the database
• Node/Express for the application logic
• dotenv from npm for managing environment variables
• db-migrate from npm for migrations
• jsonwebtoken from npm for working with JWTs
• jasmine from npm for testing

Setup PostgreSql databases

1- you need to enter psql postgresql environment usnig command:

• Create User:

CREATE USER postgres WITH PASSWORD 'postgres';

psql -U username postgres

and enter the password 'postgres' related to username.

Note that the postgresql port used is: 5432.

2- Create 2 databases using psql postgresql, one database for real developmente process and the othe is for testing, you can create the database in postgresql command environment using the command:

CREATE DATABASE store_front_dev;
CREATE DATABASE store_front_test;

Here we used 'store_front_dev' as the name for development database, and 'store_front_test' for tesing database.

3- To connect to a test database we type in terminal:

\c store_front_test

To connect to a dev database we type in terminal:

\c store_front_dev

4- To exit from postgres environment we type in terminal

\q

Setup Server and PostgreSQL connection

• Move to directory ./Udacity_store_front_backend
• Add a file name ".env" with the following content: MY_HOST=localhost MY_DB=store_front_dev MY_TEST_DB=store_front_test MY_USER=postgres MY_PASSWORD=postgres MY_ENV=test PEPPER=pepper SALT_ROUNDS=salt_rounds TOKEN_SECRET=token_secret
• Open server at 3000
• Postgresql port at 5432
• Source code ./src
• build folder ./dist

You should install some dependencies by running npm i Make sure that you're inside the project root in your terminal

You should install some dependencies by running npm i and write the name of each of the following :

bcrypt body-parser db-migrate db-migrate-pg dotenv express jsonwebtoken pg typescript @types/bcrypt @types/express @types/jasmine @types/jsonwebtoken @types/node @types/pg @types/supertest jasmine jasmine-spec-reporter supertest ts-node tsc-watch

All these packages are listed in package.json file and you can install them all by running npm i in your terminal. Remember our scripts in package.json file :

• To build your project in a dist file, type in terminal

npm run build

• To start your project in production mode, type in terminal

npm run start

• To run in development mode, type in terminal

npm run dev

( preferable as if you save any change, it restart the server itself ).

• To test your project : in your terminal run

npm run test

1. Plan to Meet Requirements In this repo there is a REQUIREMENTS.md document which outlines what this API needs to supply for the frontend, as well as the agreed upon data shapes to be passed between front and backend. This is much like a document you might come across in real life when building or extending an API.

Your first task is to read the requirements and update the document with the following:

Determine the RESTful route for each endpoint listed. Add the RESTful route and HTTP verb to the document so that the frontend developer can begin to build their fetch requests. Example: A SHOW route: 'blogs/:id' [GET]

Design the Postgres database tables based off the data shape requirements. Add to the requirements document the database tables and columns being sure to mark foreign keys. Example: You can format this however you like but these types of information should be provided Table: Books (id:varchar, title:varchar, author:varchar, published_year:varchar, publisher_id:string[foreign key to publishers table], pages:number)

NOTE It is important to remember that there might not be a one to one ratio between data shapes and database tables. Data shapes only outline the structure of objects being passed between frontend and API, the database may need multiple tables to store a single shape.

2. DB Creation and Migrations Now that you have the structure of the databse outlined, it is time to create the database and migrations. Add the npm packages dotenv and db-migrate that we used in the course and setup your Postgres database. If you get stuck, you can always revisit the database lesson for a reminder.

You must also ensure that any sensitive information is hashed with bcrypt. If any passwords are found in plain text in your application it will not pass.

3. Models Create the models for each database table. The methods in each model should map to the endpoints in REQUIREMENTS.md. Remember that these models should all have test suites and mocks.

4. Express Handlers Set up the Express handlers to route incoming requests to the correct model method. Make sure that the endpoints you create match up with the enpoints listed in REQUIREMENTS.md. Endpoints must have tests and be CORS enabled.

5. JWTs Add JWT functionality as shown in the course. Make sure that JWTs are required for the routes listed in REQUIUREMENTS.md.

6. QA and README.md Before submitting, make sure that your project is complete with a README.md. Your README.md must include instructions for setting up and running your project including how you setup, run, and connect to your database.

Before submitting your project, spin it up and test each endpoint. If each one responds with data that matches the data shapes from the REQUIREMENTS.md, it is ready for submission!