takeshi-codes / backend-boilerplate

Backend boilerplate project, using node, express, MySQL, and Docker

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README

A quickstart boilerplate project for creating an express app, and connecting to a MySQL database

Table of Contents

Installation

To install this project, you will need to have Docker installed on your machine.

Once you are ready, run docker-compose up in the root directory of this project to spin up everything

Details

The initial boilerplate was created using express-generator

Added the following tools to lint & enforce code style:

  • eslint
  • prettier
  • .editorconfig

Added sequelize to connect to a MySQL database

Created a Dockerfile for building the node container, and docker-compose.yml to build the container network, node container and MySQL container.

Uses nvm for managing node versions for multiple contributors.

Debugging

To instart debugging, run npm run debug in the root directory of the project.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

About

Backend boilerplate project, using node, express, MySQL, and Docker

License:MIT License


Languages

Language:JavaScript 86.6%Language:Dockerfile 10.3%Language:CSS 3.0%