Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/melardev/apiecomsequelizeexpress

Ecommerce API app implemented with Express js and Sequelize
https://github.com/melardev/apiecomsequelizeexpress

api e-commerce ecommerce express express-js expressjs full-stack fullstack node node-js nodejs npm orm orm-framework sequelize sequelize-cli

Last synced: about 3 hours ago
JSON representation

Ecommerce API app implemented with Express js and Sequelize

Awesome Lists containing this project

README 

        
# Bookshelf E-commerce Api

# Table of Contents

- [Introduction](#introduction)

- [Full-stack Applications](#full-stack-applications)

  * [E-commerce (shopping cart)](#e-commerce-shopping-cart)

    + [Server side implementations](#server-side-implementations)

    + [Client side implementations](#client-side-implementations)

  * [Blog/CMS](#blogcms)

    + [Server side implementations](#server-side-implementations-1)

    + [Client side](#client-side)

      - [The next come are](#the-next-come-are)

  * [Simple CRUD(Create, Read, Update, Delete)](#simple-crudcreate-read-update-delete)

    + [Server side implementations](#server-side-implementations-2)

    + [Client side implementations](#client-side-implementations-1)

      - [The next come are](#the-next-come-are-1)

  * [CRUD + Pagination](#crud--pagination)

    + [Server side implementations](#server-side-implementations-3)

      - [The next come are](#the-next-come-are-2)

    + [Client side implementations](#client-side-implementations-2)

      - [The next come are](#the-next-come-are-3)

- [Follow me](#social-media-links)

    

# Introduction

This is one of my E-commerce API app implementations. It is written in Node js, using Express and Sequelize ORM framework as the main dependencies.

This is not a finished project by any means, but it has a valid enough shape to be git cloned and studied if you are interested in this topic.

If you are interested in this project take a look at my other server API implementations I have made with:



# Full-stack Applications

## E-commerce (shopping cart)

### Server side implementations

- [Spring Boot + Spring Data Hibernate](https://github.com/melardev/SBootApiEcomMVCHibernate)

- [Spring Boot + JAX-RS Jersey + Spring Data Hibernate](https://github.com/melardev/SpringBootEcommerceApiJersey)

- [Node Js + Sequelize](https://github.com/melardev/ApiEcomSequelizeExpress)

- [Node Js + Bookshelf](https://github.com/melardev/ApiEcomBookshelfExpress)

- [Node Js + Mongoose](https://github.com/melardev/ApiEcomMongooseExpress)

- [Python Django](https://github.com/melardev/DjangoRestShopApy)

- [Flask](https://github.com/melardev/FlaskApiEcommerce)

- [Golang go gonic](https://github.com/melardev/api_shop_gonic)

- [Ruby on Rails](https://github.com/melardev/RailsApiEcommerce)

- [AspNet Core](https://github.com/melardev/ApiAspCoreEcommerce)

- [Laravel](https://github.com/melardev/ApiEcommerceLaravel)



The next to come are:

- Spring Boot + Spring Data Hibernate + Kotlin

- Spring Boot + Jax-RS Jersey + Hibernate + Kotlin

- Spring Boot + mybatis

- Spring Boot + mybatis + Kotlin

- Asp.Net Web Api v2

- Elixir

- Golang + Beego

- Golang + Iris

- Golang + Echo

- Golang + Mux

- Golang + Revel

- Golang + Kit

- Flask + Flask-Restful

- AspNetCore + NHibernate

- AspNetCore + Dapper



### Client side implementations

This client side E-commerce application is also implemented using other client side technologies:

- [React Redux](https://github.com/melardev/ReactReduxEcommerceRestApi)

- [React](https://github.com/melardev/ReactEcommerceRestApi)

- [Vue](https://github.com/melardev/VueEcommerceRestApi)

- [Vue + Vuex](https://github.com/melardev/VueVuexEcommerceRestApi)

- [Angular](https://github.com/melardev/AngularEcommerceRestApi)



## Blog/CMS

### Server side implementations

- [Spring Boot + Spring Data Hibernate](https://github.com/melardev/SpringBootApiBlog)

- [Go + Gin Gonic](https://github.com/melardev/GoGonicBlogApi)

- [NodeJs + Mongoose](https://github.com/melardev/ApiBlogExpressMongoose)

- [Laravel](https://github.com/melardev/LaravelApiBlog)

- [Ruby on Rails + JBuilder](https://github.com/melardev/RailsApiBlog)

- [Django + Rest-Framework](https://github.com/melardev/DjangoApiBlog)

- [Asp.Net Core](https://github.com/melardev/AspCoreApiBlog)

- [Flask + Flask-SQLAlchemy](https://github.com/melardev/FlaskApiBlog)



The next to come are:

- Spring Boot + Spring Data Hibernate + Kotlin

- Spring Boot + Jax-RS Jersey + Hibernate + Kotlin

- Spring Boot + mybatis

- Spring Boot + mybatis + Kotlin

- Asp.Net Web Api v2

- Elixir

- Golang + Beego

- Golang + Iris

- Golang + Echo

- Golang + Mux

- Golang + Revel

- Golang + Kit

- Flask + Flask-Restful

- AspNetCore + NHibernate

- AspNetCore + Dapper



### Client side

- [Vue + Vuex](https://github.com/melardev/VueVuexBlog)

- [Vue](https://github.com/melardev/VueBlog)

- [React + Redux](https://github.com/melardev/ReactReduxBlog)

- [React](https://github.com/melardev/ReactBlog)

- [Angular](https://github.com/melardev/AngularBlog)



The next come are

- Angular NgRx-Store

- Angular + Material

- React + Material

- React + Redux + Material

- Vue + Material

- Vue + Vuex + Material

- Ember



## Simple CRUD(Create, Read, Update, Delete)

### Server side implementations

- [Spring Boot + Spring Data Hibernate](https://github.com/melardev/SpringBootApiJpaCrud)

- [Spring boot + Spring Data Reactive Mongo](https://github.com/melardev/SpringBootApiReactiveMongoCrud)

- [Spring Boot + Spring Data Hibernate + Jersey](https://github.com/melardev/SpringBootApiJerseySpringDataCrud)

- [NodeJs Express + Mongoose](https://github.com/melardev/ExpressMongooseApiCrud)

- [Nodejs Express + Bookshelf](https://github.com/melardev/ExpressBookshelfApiCrud)

- [Nodejs Express + Sequelize](https://github.com/melardev/ExpressSequelizeApiCrud)

- [Go + Gin-Gonic + Gorm](https://github.com/melardev/GoGinGonicApiGormCrud)

- [Ruby On Rails](https://github.com/melardev/RailsApiCrud)

- [Ruby On Rails + JBuilder](https://github.com/melardev/RailsApiJBuilderCrud)

- [Laravel](https://github.com/melardev/LaravelApiCrud)

- [AspNet Core](https://github.com/melardev/AspNetCoreApiCrud)

- [AspNet Web Api 2](https://github.com/melardev/AspNetWebApiCrud)

- [Python + Flask](https://github.com/melardev/FlaskApiCrud)

- [Python + Django](https://github.com/melardev/DjanogApiCrud)

- [Python + Django + Rest Framework](https://github.com/melardev/DjangoRestFrameworkCrud)



### Client side implementations

- [VueJs](https://github.com/melardev/VueAsyncCrud)



#### The next come are

- Angular NgRx-Store

- Angular + Material

- React + Material

- React + Redux + Material

- Vue + Material

- Vue + Vuex + Material

- Ember

- Vanilla javascript



## CRUD + Pagination

### Server side implementations

- [Spring Boot + Spring Data + Jersey](https://github.com/melardev/SpringBootJerseyApiPaginatedCrud)

- [Spring Boot + Spring Data](https://github.com/melardev/SpringBootApiJpaPaginatedCrud)

- [Spring Boot Reactive + Spring Data Reactive](https://github.com/melardev/ApiCrudReactiveMongo)

- [Go with Gin Gonic](https://github.com/melardev/GoGinGonicApiPaginatedCrud)

- [Laravel](https://github.com/melardev/LaravelApiPaginatedCrud)

- [Rails + JBuilder](https://github.com/melardev/RailsJBuilderApiPaginatedCrud)

- [Rails](https://github.com/melardev/RailsApiPaginatedCrud)

- [NodeJs Express + Sequelize](https://github.com/melardev/ExpressSequelizeApiPaginatedCrud)

- [NodeJs Express + Bookshelf](https://github.com/melardev/ExpressBookshelfApiPaginatedCrud)

- [NodeJs Express + Mongoose](https://github.com/melardev/ExpressApiMongoosePaginatedCrud)

- [Python Django](https://github.com/melardev/DjangoApiCrudPaginated)

- [Python Django + Rest Framework](https://github.com/melardev/DjangoRestFrameworkPaginatedCrud)

- [Python Flask](https://github.com/melardev/FlaskApiPaginatedCrud)

- [AspNet Core](https://github.com/melardev/AspNetCoreApiPaginatedCrud)

- [AspNet Web Api 2](https://github.com/melardev/WebApiPaginatedAsyncCrud)



#### The next come are

- NodeJs Express + Knex

- Flask + Flask-Restful

- Laravel + Fractal

- Laravel + ApiResources

- Go with Mux

- AspNet Web Api 2

- Jersey

- Elixir



### Client side implementations

- [Angular](https://github.com/melardev/AngularPaginatedAsyncCrud)

- [React-Redux](https://github.com/melardev/ReactReduxPaginatedAsyncCrud)

- [React](https://github.com/melardev/ReactAsyncPaginatedCrud)

- [Vue + Vuex](https://github.com/melardev/VueVuexPaginatedAsyncCrud)

- [Vue](https://github.com/melardev/VuePaginatedAsyncCrud)



#### The next come are

- Angular NgRx-Store

- Angular + Material

- React + Material

- React + Redux + Material

- Vue + Material

- Vue + Vuex + Material

- Ember

- Vanilla javascript



# Social media links

- [Youtube Channel](https://youtube.com/melardev) I publish videos mainly on programming

- [Blog](http://melardev.com) Sometimes I publish the source code there before Github

- [Twitter](https://twitter.com/@melardev) I share tips on programming



## WARNING

I have mass of projects to deal with so I make some copy/paste around, if something I say is missing or is wrong, then I apologize

and you may let me know opening an issue.



# Get started

1. Install dependencies

`npm install`

2. Rename the .env.example to .env and setup database, according to your needs

The database settings can be changed from the .env file, you can switch between sqlite and MySQL effortlessly by 

only changing the dialect and the username/password for your MySQL server if you are using MySQL.

I strongly encourage you to use MySQL because using SQLite you may run into " sqlite database locked" issues.

if you use sqlite(default) then:

`node_modules\.bin\sequelize db:migrate`

if mysql or other then:

`node_modules\.bin\sequelize db:drop && node_modules\.bin\sequelize db:create && node_modules\.bin\sequelize db:migrate`

3. Seed database

`node_modules\.bin\sequelize db:seed:all`

Please notice that regarding the seeding implementation I am not doing it the _sequelize_ way

because I do not use the sequelize param provided y the up function, instead I use mine.



4. The last step is up to you, you can either open it in an IDE and debug it, or you can open the api.postman_collection.json with Postman, and then execute the queries



# Features

- Authentication / Authorization

- Paging

- CRUD operations on products, comments, tags, categories

![Fetching products page](./github_images/postman.png)

- Orders, guest users may place an order

![Database diagram](./github_images/db_structure.png)



# What you will learn

- Sequelize ORM

    - associations: hasMany, belongsTo, belongsToMany

    - scopes

    - virtuals

    - complex queries

    - paging

    - eager loading, select columns on related associations

    

- express

    - middlewares

    - authentication

    - authorization

- seed data with faker js

- misc

    - project structure

    - dotenv

    

# Understanding the project

The project is meant to be educational, to learn something beyond the hello world thing we find in a lot, lot of 

tutorials and blog posts. Since its main goal is educational, I try to make as much use as features of APIs, in other

words, I used different code to do the same thing over and over, there is some repeated code but I tried to be as unique

as possible so you can learn different ways of achieving the same goal.

Project structure:

- models: Mvc, it is our domain data.

- dtos: it contains our serializers, they will create the response to be sent as json. They also take care of validating the input(feature incomplete)

- controllers: well this is the mvC, our business logic.

- routes: they register routes to router middleware

- middleware: some useful middleware, mainly the authentication and authorization middleware.

- config: the database configurer.

- seeders: contains the file that seeds the database.

- .env the env file from where to populate the process.env node js environment variable

- public: contains the uploaded files.



# Useful Sequelize CLI commands

Replace backslashes by forward slashes if you are in Linux or Mac



- Create database

`node_modules\.bin\sequelize db:create`

- Drop database

`node_modules\.bin\sequelize db:drop`

- Run migration files

`node_modules\.bin\sequelize db:migrate`



- Seed all

`node_modules\.bin\sequelize db:seed:all`

- Undo only last seed

`node_modules\.bin\sequelize db:seed:undo`

- Undo all

`node_modules\.bin\sequelize db:seed:undo:all`



- Drop, Create and migrate

`reset.bat`

- Drop And migrate

`drop_migrate.bat`



# Steps followed to create this project (incomplete)



```shell

npm install --save sequelize

# npm install --save sqlite3

npm install --save mysql2

# or

# yarn add sqlite3

# yarn add mysql2

npm install --save sequelize-cli

# Generate sequelize folders and config.json with:

./node_modules/.bin/sequelize init



# Populate config.json with connection settings

# then create the database with:

$ ./node_modules/.bin/sequelize db:create



# generate models and migration files

$ node_modules/.bin/sequelize model:generate --name User --attributes firstName:string,lastName:string,email:string



# write migration code



# migrate

$ node_modules/.bin/sequelize db:migrate



# generate seeds

$ .\node_modules\.bin\sequelize seed:generate --name seed-categories



# seed

$ node_modules/.bin/sequelize db:seed:all

```



# TODO

- Hook user pre create, save ROLE_USER

- Timestamped Model

- I have troubles setting column names with underscores(i.e userId), this is why I named the foreign key columns with camelcase(userId, orderId)

and not underscore, in the future I have to refactor to snake case instead

- Unit testing

- Improve README.md



# Resources

- [Sequelize](http://docs.sequelizejs.com/)

- [Sequelize Scopes](http://docs.sequelizejs.com/manual/tutorial/scopes.html)

- [Express](https://expressjs.com/)

- [Express-jwt](https://github.com/auth0/express-jwt)

- [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken)

- [Required attribute](https://stackoverflow.com/questions/52063685/sequelize-eager-loading-associations-with-optional-scopes)

- [sanitize-html](https://www.npmjs.com/package/sanitize-html)