About The Project

A sample project using Node.JS with Express Framework that introduce using of

• Dockerised application with nodejs, mysql, phpmyadmin
• CRUD with API using JWT Authentication
• Google Login using OAuth2
• Google Cloud Bucket File Upload
• Test Cases for API using jest
• Sequlize using MySQL (Seeders, Model Validation)
• Mail Sending using nodemailer

Getting Started

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

Prerequisites

Following tools are required to setup this project , follow steps as per your distro from below links to install docker stuff!

• Docker installed, Refer Install Docker
• Docker Compose installed, Refer these Install Docker Compose

Installation (Linux Environment)

1. Clone the repo

git clone https://github.com/hirokimoto/node-starter.git

2. Go to directory

cd node-starter

3. Copy .env.example to .env

cp .env.example .env

4. Do necessary configuration in .env and run project

docker-compose up -d

5. Verify setup

docker ps

5. To stop your running project

docker-compose down

• Refer API Docs : Link will be available soon

Acknowledgements

• Express Framework
• Passport JS
• Sequelize
• Jest
• Docker