1.0.2 • Published 1 year ago

store-front-by-amr v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

Store Front

Installation

You need to have Node & Docker installed in your machine, then you can follow one of these two ways to clone and install project dependencies.

One way

  • Is to open your terminal and run command npx store-front-by-amr <Project-Name> & follow instructions on your terminal.

    Another way

    1- clone repo on https://github.com/3amr7ussein/store-front you local machine 2- cd into project directory and run npm install 3- run docker-compose up & keep this terminal running 4- Open new terminal and run project scripts
  • npm run test to run jasmine unit test on the project
  • npm start to fill database with dummy data & start server on http://localhost:4000
HTTP VerbsEndpointsAction
GET/signupSign Up Page
POST/signupCreate New User
GET/signinSign In Page
POST/signinAuthenticate user
GET/signoutRemove user token

users/ Route

HTTP VerbsEndpointsAction
GET/Users Table Require Authentication
GET/current-usercurrent logined user Require Authentication
GET/searchSearch User By ID Page
POST/:idGet data of user with :id Require Authentication

products/ Route

HTTP VerbsEndpointsAction
GET/Products Table Require Authentication
GET/toptop 5 popular products
GET/createNew product Page
POST/createAdd new product row Require Authentication
GET/searchSearch Products Page
GET/:idSearch Product By :id
GET/categoryFind product by category Page
GET/category/:categorySearch Products by :category

orders/ Route

HTTP VerbsEndpointsAction
GET/Orders Table Page
GET/createNew Order Page
POST/createAdd New Order Row
GET/addItemNew Order Item Page
POST/addItemAdd New Order Item
GET/currentUser Active Order Page
GET/current/:userIdGet User Active Order by userId Require Authentication
GET/completedUser Completed Order Page
GET/completed/:userIdGet User Completed Order by userId Require Authentication

Database Schema

Used Technologies

  • NodeJS This is a cross-platform runtime environment built on Chrome's V8 JavaScript engine used in running JavaScript codes on the server. It allows for installation and managing of dependencies and communication with databases.

  • ExpressJS This is a NodeJS web application framework.

  • Postgres PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

  • Jasmine Jasmine is a behavior-driven development framework for testing JavaScript code.

  • Docker Docker’s comprehensive end to end platform includes UIs, CLIs, APIs and security that are engineered to work together across the entire application delivery lifecycle.