NodeJs Project

Table of Contents

• Project Overview
• Features
• Built with
• APP Link
• API Documentation
• API End Points
• Known Issues
• Installation
• Test
• Contributing
• License

Project Overview

NodeJs Project is the backend of build of an e-commerce system which allows users to search, add items to their shopping cart, create orders, and checkout successfully.it was built from scratch using mysql , sequelize , JavaScript and Node.js

Features

• Users can register/login using website custom forms, or through facebook,
• Users can search items through search box
• Users can see item details by selecting a specific item
• Users can add items to their shopping carts
• Users can update personal profiles with shipping addresses and other info
• Items are displayed properly based on the selected department and category
• Users can view all items when entering the website.

Built with

• sql
• mysql
• sequelize
• JavaScript
• Node.js
• Express framework

APP Link

Link to app on heroku.

API Documentation

POSTMAN API documentation here

API End Points

HTTPS	ENDPOINT	DESCRIPTION
POST	/customers	User Registration
POST	customers/login	Login Cutomer
POST	/customers/facebook	Social login
PUT	/customers	Update Cutomer account
PUT	/customers/address	Update Cutomer Address
PUT	/customers/creditcard	Update Customer credit card detail
GET	/products/	Fetch all products
GET	/products/inCategory/:categoryId	Fetches products based on Category
GET	/products/inDepartment/:department	Fetches products based on Department
GET	/products/search	Search for products
GET	/products/:productId/details	Get details of a product
POST	/shoppingcart/add	Adds product to Shopping Cart
POST	/orders	Create an order
POST	/stripe/charge	Create charge with Stripe

Known issues

Everything works as expected; However:

• This project is just a backend app, i.e. no frontend implementation.

Installation

• $ git clone https://github.com/oyedejipeace/tienda.git
• $ cd tienda
• $ npm i , to install dependencies
• Create .env file using the .env.sample file as a guide
• $ npm start:dev, to start the server Once the server starts-up, you can query the api at http://localhost:5000/ using the end points stated above.

Test

• $ npm test

Contributing

Feel free to 🍴 fork this repository

👯 Clone this repository to your local machine using https://github.com/oyedejipeace/tienda.git

Make Contributions

🔃 Create a new pull request using https://github.com/oyedejipeace/tienda/compare

License

• MIT license
• Copyright 2018 © Tienda