Bookshelf E-commerce Api

Table of Contents

• Introduction
• Full-stack Applications
  • E-commerce (shopping cart)
    • Server side implementations
    • Client side implementations

    <li>
      <a rel="nofollow noopener" target="_blank" href="#blogcms">Blog/CMS</a></p> <ul dir="auto">
        <li>
          <a rel="nofollow noopener" target="_blank" href="#server-side-implementations-1">Server side implementations</a>
        </li>
        <li>
          <a rel="nofollow noopener" target="_blank" href="#client-side">Client side</a></p> <ul dir="auto">
            <li>
              <a rel="nofollow noopener" target="_blank" href="#the-next-come-are">The next come are</a>
            </li>
          </ul>
        </li>
      </ul>
    </li>
    
    <li>
      <a rel="nofollow noopener" target="_blank" href="#simple-crudcreate-read-update-delete">Simple CRUD(Create, Read, Update, Delete)</a></p> <ul dir="auto">
        <li>
          <a rel="nofollow noopener" target="_blank" href="#server-side-implementations-2">Server side implementations</a>
        </li>
        <li>
          <a rel="nofollow noopener" target="_blank" href="#client-side-implementations-1">Client side implementations</a></p> <ul dir="auto">
            <li>
              <a rel="nofollow noopener" target="_blank" href="#the-next-come-are-1">The next come are</a>
            </li>
          </ul>
        </li>
      </ul>
    </li>
    
    <li>
      <a rel="nofollow noopener" target="_blank" href="#crud--pagination">CRUD + Pagination</a></p> <ul dir="auto">
        <li>
          <a rel="nofollow noopener" target="_blank" href="#server-side-implementations-3">Server side implementations</a></p> <ul dir="auto">
            <li>
              <a rel="nofollow noopener" target="_blank" href="#the-next-come-are-2">The next come are</a>
            </li>
          </ul>
        </li>
        
        <li>
          <a rel="nofollow noopener" target="_blank" href="#client-side-implementations-2">Client side implementations</a></p> <ul dir="auto">
            <li>
              <a rel="nofollow noopener" target="_blank" href="#the-next-come-are-3">The next come are</a>
            </li>
          </ul>
        </li>
      </ul>
    </li>
  </ul>
  

  • Follow me

  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
  • Spring Boot + JAX-RS Jersey + Spring Data Hibernate
  • Node Js + Sequelize
  • Node Js + Bookshelf
  • Node Js + Mongoose
  • Python Django
  • Flask
  • Golang go gonic
  • Ruby on Rails
  • AspNet Core
  • Laravel

  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
  • React
  • Vue
  • Vue + Vuex
  • Angular

  Blog/CMS

  Server side implementations

  • Spring Boot + Spring Data Hibernate
  • Go + Gin Gonic
  • NodeJs + Mongoose
  • Laravel
  • Ruby on Rails + JBuilder
  • Django + Rest-Framework
  • Asp.Net Core
  • Flask + Flask-SQLAlchemy

  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
  • Vue
  • React + Redux
  • React
  • Angular

  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
  • Spring boot + Spring Data Reactive Mongo
  • Spring Boot + Spring Data Hibernate + Jersey
  • NodeJs Express + Mongoose
  • Nodejs Express + Bookshelf
  • Nodejs Express + Sequelize
  • Go + Gin-Gonic + Gorm
  • Ruby On Rails
  • Ruby On Rails + JBuilder
  • Laravel
  • AspNet Core
  • AspNet Web Api 2
  • Python + Flask
  • Python + Django
  • Python + Django + Rest Framework

  Client side implementations

  • VueJs

  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
  • Spring Boot + Spring Data
  • Spring Boot Reactive + Spring Data Reactive
  • Go with Gin Gonic
  • Laravel
  • Rails + JBuilder
  • Rails
  • NodeJs Express + Sequelize
  • NodeJs Express + Bookshelf
  • NodeJs Express + Mongoose
  • Python Django
  • Python Django + Rest Framework
  • Python Flask
  • AspNet Core
  • AspNet Web Api 2

  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
  • React-Redux
  • React
  • Vue + Vuex
  • Vue

  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 I publish videos mainly on programming
  • Blog Sometimes I publish the source code there before Github
  • Twitter 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.binsequelize db:migrate
     if mysql or other then:
     node_modules.binsequelize db:drop && node_modules.binsequelize db:create && node_modules.binsequelize db:migrate
  3. Seed database
     node_modules.binsequelize 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
  • Orders, guest users may place an order

  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.binsequelize db:create
  • Drop database
    node_modules.binsequelize db:drop
  • Run migration files
    node_modules.binsequelize db:migrate
  • Seed all
    node_modules.binsequelize db:seed:all
  • Undo only last seed
    node_modules.binsequelize db:seed:undo
  • Undo all
    node_modules.binsequelize db:seed:undo:all
  • Drop, Create and migrate
    reset.bat
  • Drop And migrate
    drop_migrate.bat

  Steps followed to create this project (incomplete)

  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.binsequelize 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
  • Sequelize Scopes
  • Express
  • Express-jwt
  • jsonwebtoken
  • Required attribute
  • sanitize-html