m3_codebase

Microservice deploy library

m3 is a small microservice wrapper, based on express, redis, jwt, and socket.io.

Let's see how to use:

• Install wih npm i @carlostkd7/m3
• Create a script, i.e. builder.js:

builder.js:

var ms = require("@carlostkd7/m3");

ms.build( {service: "supertest",init : true} ).then(function(){
	 ms.apify()
});

In the above example, the microservice name is supertest.

• To run the script with node or, if you prefer, nodemon, just do a

$ nodemon builder.js

• If this is your first time running the build option, a folder with same name as your microservice (supertest for me) will be created as follows with an entire example app:

-- package.json
-- builder.js

#this is your new microservice structure:
-- supertest/
	-- .env
	-- app.js
	-- io.js
	-- modules.js
	-- www/
		-- index.html
		-- main.js

• The process will create an example api that you can just start to code, at supertest/app.js and supertest/io.js you can put all your endpoints and socket.io actions, and import all your required modules inside supertest/modules.js

• This structure will help you to have a clean app.js and io.js files, without the pain of doing lots of imports on each file, just put your module calls inside the modules.js script and it will be available at inn.modules.ms object.

• After your first launch the builder.js on command line, nodemon, npm etc., you will be able to test your application on localhost:3000, and a simple web chatroom will be shown.

• If you don't provide any ssl keys (server.key and server.cert files), the server will start with http, otherwise, it will launch your app under https.

• The API already have a jwt authentication middleware, and a simple rule is required here: any endpoint that includes "auth" on it's url requires a valid headers authorization token. If you require open endpoints, don't use the auth prefix on them.

• it also supports two database engines (mysql and mongodb under mongoose), both of them located on inn.connections.

You can customize all your app needs inside .env file, we are also providing a sample with all required variables

I recomend to use nodemon for testing and dev, it is already on dependencies.

Next step is to automate the dockerization app process.

Regards!