IMM9O / -capstone-udacity-storefront

A full-stack Shopping app built with PERN Stack 📦

Storefront

Link To Live Web

Full stack app built with Postgres-Express-React-Nodejs Stack, hosted on AWS, and use CircleCI as CI/CD.

Table of content

• Dependencies
• Infrastructure
• Pipeline
• Project setup
• Available scripts
• Three tiers architecture
  • Database
  • API
  • UI

Tech stack

• DB
  • postgres
• API
  • NodeJs
  • Typescript
  • ExpressJs
• UI
  • ReactJs
  • AntD
• Hosted
  • AWS
• CI/CD
  • CircleCI

Project setup

1. Clone the project git clone https://github.com/IMM9O/udacity-storefront.git.

2. Installation is done using the npm install command: npm install.

Note: Install command will also install client&server dependencies

3. Install postgres on your local machine from this link.

4. Open Sql Shell (psql).

5. Connect to the default postgres database user psql -U postgres.

6. In psql run the following to create the dev, test, and production databases.

/** DEV database **/
CREATE DATABASE udacity_storefront_dev;
/** Test database **/
CREATE DATABASE udacity_storefront_test;
/** Production database **/
CREATE DATABASE udacity_storefront;

7. Setup database npm run db:up.

8. Make a copy for .env.example file to .env and then change the variables to match your environment.

Don't forget to replace {database_password} with your current postgres password

NODE_ENV=dev
DB_HOST=127.0.0.1
DB_USER=postgres
DB_PASSWORD={database_password}
DB_DATABASE_DEV=udacity_storefront_dev
DB_DATABASE_TEST=udacity_storefront_test
DB_DATABASE_PROD=udacity_storefront
BCRYPT_PASSWORD=
SALT_ROUNDS=
TOKEN_SECRET=

9. To start the app run npm start.

Note: This command will start both app the client and the server

Database Port	Server Port	Client Port
5432	3001	3000

Available scripts

• To start both frontend and backend app run npm start
• To check app format run npm run prettier
• To check app error run npm run lint
• To test both frontend and backend app run npm run test
• To build both frontend and backend app run npm run build

Database

For More information go to here => Database

APIs

For More information go to here => REQUIREMENTS

URL	Type	Token Required
/api/products/	GET	❌
/api/products/:id	GET	❌
/api/products/	POST	✔
/api/products/:id	UPDATE	✔
/api/products/:id	DELETE	✔
/api/users/	GET	✔
/api/users/:id	GET	✔
/api/users/	POST	❌
/api/users/:id	UPDATE	✔
/api/users/:id	DELETE	✔
/api/users/:id/authenticate	POST	❌
/api/orders/:userId	GET	✔
/api/orders/completed/:userId	GET	✔
/api/orders/active/:userId	GET	✔
/api/orders/:id	GET	✔
/api/orders/	POST	✔
/api/orders/:id	UPDATE	✔
/api/orders/:id	DELETE	✔
/api/orders/:id/products	POST	✔
/api/orders/:id/products	GET	✔

UI

The UI built with the help of create react app. For More information go to here => UI