CofferHub / nodejs-mvc-boilerplate

A boilerplate of NodeJS with MVC architecture using sequelizeORM.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Node.js MVC Template

Photo by Jeffery Ho on Unsplash

A boilerplate of NodeJS with MVC architecture using sequelizeORM.

Table of contents

General info

The main purpose of the project was to create a NodeJS template with a MVC Design Pattern.

Screenshots

Technologies

  • NodeJS - >= 13.0
  • Express Framework - >= ^4.17.1
  • ORM: Sequelize - >= ^6.6.2
  • BD: MySql >= 8.0.21
  • Template engine: EJS >= ^3.1.5
  • Front-end framework: MaterializeCss - ^1.0.0-rc.2

Setup

Describe how to install / setup your local environement / add link to demo version.

Structure

├── bin
│   └── www
│
├── dist
│
├── public
│   ├── css
│   │   └── style.css
│   ├── img
│   │   └── favicon.ico
│   └── scrits
│       └── script.js
│
├── src
│   ├── config
│   │   ├── auth.js
│   │   └── passport.js
│   │
│   ├── controllers
│   │   └── UserController.js
│   │
│   ├── database
│   │   ├── config
│   │   │   └── database.js
│   │   ├── migrations
│   │   └── seeders
│   │
│   ├── models
│   │   ├── index.js
│   │   └── User.js
│   │
│   ├── routes
│   │   └── index.js
│   │
│   ├── views
│   │   ├── err
│   │   │   └── index.js
│   │   ├── layout
│   │   │   ├── _partials
│   │   │   │   ├── _footer.js
│   │   │   │   ├── _head.js
│   │   │   │   └── _header.js
│   │   │   └── index.js
│   │   └── page
│   │       ├── about.js
│   │       ├── auth.js
│   │       ├── contact.js
│   │       ├── index.js
│   │       ├── login.js
│   │       └── register.js
│   │
│   └── app.js
│
├── test
│   ├── sum.js
│   └──  sum.test.js
│
├── .editorConfig
├── .eslintrc.json
├── .sequelizerc
├── jest.config.json
├── LICENSE
├── package.json
└── README.md

Code Examples

Show examples of usage: put-your-code-here

Features

List of features ready and TODOs for future development

  • Awesome feature 1
  • Awesome feature 2
  • Awesome feature 3

To-do list:

  • Wow improvement to be done 1
  • Wow improvement to be done 2

Contact

Created by CofferHub - feel free to contact us!

About

A boilerplate of NodeJS with MVC architecture using sequelizeORM.

License:MIT License


Languages

Language:EJS 50.2%Language:JavaScript 47.5%Language:CSS 2.3%