https://github.com/radiegtya/micro-express

Boilerplate for Express Microservice with nice structure and event driven development
https://github.com/radiegtya/micro-express

Last synced: 6 days ago
JSON representation

Boilerplate for Express Microservice with nice structure and event driven development

• Host: GitHub
• URL: https://github.com/radiegtya/micro-express
• Owner: radiegtya
• Created: 2018-07-21T09:54:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-24T09:26:22.000Z (over 6 years ago)
• Last Synced: 2024-11-02T20:42:05.358Z (about 2 months ago)
• Language: JavaScript
• Size: 42 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Micro Express

Micro Express is a Boilerplate to quickly developing an event driven microservice app using Express Js. This boilerplate might be not the best microservice implementation out there, but we hope any developer could get started fast, and got basic understanding about how to implement microservice using Express Js.

## Installation

Make sure that NodeJs and Npm installed on your PC (we suggest using NodeJs >= 8.x)

```

$ git clone https://github.com/radiegtya/express-microservice-boilerplate

$ cd express-microservice-boilerplate

$ npm install

$ npm i -g nodemon

$ npm start

```

## Structure

When calling command "npm start", actually we run "nodemon starter.js". This "starter.js" responsible

to call our main application that life inside "app" folder, and also make use of "es6" (because by default express didn't support it).

In our app folder, we have some file such as:

- index   =>    responsible for import important files, modules and starting the nodejs app

- controllers   =>    here you can write your logic. You can combine it with model if needed

- router    =>    map your url

## Documentation

Coming Soon, for now we'll made some examples inside "examples" folder