evaengine / evaengine.js Goto Github PK

View Code? Open in Web Editor NEW

32.0 7.0 10.0 328 KB

A micro service development engine for node.js

License: MIT License

Makefile 0.09% JavaScript 99.13% HTML 0.78%

dependency-injection es2017 framework async-await orm distributed microservice cli sequelize swagger nodejs

evaengine.js's Introduction

EvaEngine For NodeJS

A micro service development engine for NodeJS.

Full DI support (Injected by ES7 decorators as well)
ES7 async & await support
CLI mode support (easily convert to schedules)
Better exceptions design
ORM support (Based on Sequelize)
Quick test by mocking request & response
Builtin cache layer
Builtin session / token authentications
Http client with fully debugging log
Distributed tracing log support (Zipkin compatible)
API document generator

Quick Start

Clone this skeleton project to quick start:

EvaSkeleton.js

项目规范(中文版)

Run as web server

import { EvaEngine } from 'evaengine';

const engine = new EvaEngine({
  projectRoot: `${__dirname}/..`,
  port: 3000
});

engine.bootstrap();
engine.use('/', (req, res) => {
  res.json({ hello: 'world' });
});
engine.run();

Then visit http://localhost:3000 to view API.

Run as CLI

import { EvaEngine } from 'evaengine';
import * as UserCommands from './commands/user';
const engine = new EvaEngine({
  projectRoot: `${__dirname}/..`
}, 'cli');
engine.registerCommands(UserCommands);
(async() => {
    await engine.runCLI();
})();

Run as Cron Job

import { EvaEngine } from 'evaengine';
import * as HelloWorldCommands from './commands/hello_world';

const engine = new EvaEngine({
  projectRoot: `${__dirname}/..`
}, 'cli');
engine.registerCommands([
  HelloWorldCommands
]);

engine.runCrontab('0/10 * * * * *', 'hello:world --id=EvaEngine');

Swagger Support

Process as follow:

ES7 Files =(Babel)=>
ES5 Files =(acorn)=>
AST =(filter)=>
Annotations =(doctrine)=>
JsDocs =(convert)=>
Fragments + EvaEngine Exceptions + Sequelize Models =(Merge & Compile)=>
Swagger Specification JSON File

Debug with Projects

cd EvaNode
npm link
cd your_project
npm link evaengine

Global Environment Variables

NODE_ENV
PORT
LOG_LEVEL
CLI_NAME
MAX_REQUEST_DEBUG_BODY
SEQUELIZE_REPLICATION_CONFIG_KEY : change sequelize replication config key

Generate Entities

./node_modules/.bin/engine make:entity
./node_modules/.bin/engine make:dbview

Import eslint with airbnb code standard for Webstorm

WebStorm > Preferences > Editor > Code Style > JavaScript > Scheme > Import Scheme > Choose airbnb_code_style.xml under this project

evaengine.js's People

Contributors

Stargazers

Watchers

Forkers

guoyu07 yongmuzhang easyconn kittencup frey-fu theharveyz bsdelf expertping npmmirror

evaengine.js's Issues

Tracer 一定概率发生 The header content contains invalid characters

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀