vuthysreang / express_nodemailer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NodeMailer Express Sequelize Docker Postgres

Backend API for Nodemailer-express project.

Built With

Project Structure

.

[Project root directory]
├── bin
│   └── www ----------------------- (generate by express)
├── common ------------------------ (define our general logic)
├── config
│   └── config.js ----------------- (generate by sequelize)
├── controllers ------------------- (define our app logic here)
├── database
│   ├── migrations ---------------- (generate by sequelize)
│   ├── models -------------------- (generate by sequelize)
│   └── seeders ------------------- (generate by sequelize)
├── public ------------------------ (static files)
├── routes ------------------------ (define our routers)
├── scripts
│   └── start.sh ------------------ (define our entrypoint script)
├── views ------------------------- (view templates)
├── .dockerignore ----------------- (ignore copy local files to image)
├── .gitignore
├── .sequelizerc ------------------ (define sequelize structure)
├── app.js ------------------------ (core components)
├── docker-compose_dev.yml ------------ (use to start docker services)
├── Dockerfile -------------------- (use to build docker image)
└── package.json

Getting Started

To get a local copy up and running follow these simple steps.

  • Install all dependencies using NPM

    npm install

  • Run Docker

    docker-compose -f docker-compose_DEV.yml up -d

  • Run project using NPM

    npm run dev

  • Terminate Docker

    docker-compose -f docker-compose_DEV.yml down -v

Prerequisites

About


Languages

Language:JavaScript 84.4%Language:Shell 5.9%Language:EJS 4.8%Language:Dockerfile 2.6%Language:Pug 1.6%Language:CSS 0.7%