README.md

Create Sequelize Express

Create Sequelize-Express apps with no configuration.

• Creating an App – How to create a new app.

Create Sequelize-Express works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.

Quick Overview

npm install -g create-sequelize-express
npx create-sequelize-express my-app
cd my-app
npm start

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Then open http://localhost:3000/ to see your app.

Get Started Immediately

You don’t need to install or configure tools.
They are preconfigured and hidden so that you can focus on the code.

Just create a project, and you’re good to go.

Creating an App

You’ll need to have Node >= 6 on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.

To create a new app:

create-sequelize-express my-app

It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:

my-app
├── app.js
├── bin
│   └── www
├── package-lock.json
└── src
    ├── config
    │   ├── config.json
    │   └── setup.js
    ├── controllers
    │   ├── auth.js
    │   └── users.js
    ├── migrations
    │   └── 20180918182624-create-user.js
    ├── models
    │   ├── index.js
    │   └── user.js
    ├── routes
    │   ├── auth.js
    │   └── index.js
    ├── seeders
    └── utils
        ├── Commons.js
        ├── Constants.js
        ├── Responder.js
        ├── ResponseTemplate.js
        ├── Strings.js
        └── Validator.js

Once the installation is done, you can open your project folder:

cd my-app

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.

A copy of the user guide will be created as README.md in your project folder.

What’s Included?

Your environment will have everything you need to build a modern express REST API with any relational database with the help of sequelize:

• Simple and organized directory structure
• Easily configurable accross multiple environments
• Built in JWT Authentication
• Built in Response and String templates that you can use anytime aywhere
• Installs all required tools to setup an Express Rest API

License

Create Sequelize Express is open source software licensed as Apache 2.0.