https://github.com/famanoder/eryue

:cherries: A framework for full stack development of Nodejs for SMEs(small and medium-sized enterprises)！
https://github.com/famanoder/eryue

decorator dependency-injection functional koa mvc nodejs smes

Last synced: 3 months ago
JSON representation

:cherries: A framework for full stack development of Nodejs for SMEs(small and medium-sized enterprises)！

• Host: GitHub
• URL: https://github.com/famanoder/eryue
• Owner: famanoder
• Created: 2016-12-25T17:22:55.000Z (about 8 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-03T21:01:59.000Z (about 2 years ago)
• Last Synced: 2024-04-14T14:54:45.488Z (10 months ago)
• Topics: decorator, dependency-injection, functional, koa, mvc, nodejs, smes
• Language: JavaScript
• Homepage:
• Size: 603 KB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/famanoder/eryue.svg?branch=dev)](https://travis-ci.org/famanoder/eryue)

>  A framework for full stack development of Nodejs for SMEs(small and medium-sized enterprises)！

### Usage

-----

* **Install**

```js

npm i @eryue/core

// or

yarn add @eryue/core

```

* **Hello, world !**

```js

import Eryue, {Router} from '@eryue/core';

@Router.get({

  greet: 'Hello, world !'

})

class App extends Eryue {}

new App();

// curl localhost:8000/greet

// => Hello, world ! 

```

### Decorators

----- 

* **@Config(Object|String)**

we can bind our app's config from here, if option is String, we'll think it's a file and try to ensure it exists then require it as config, or just an Object, some time we can visit it by `cx.config`;

eg: 

```js

@Config({

  port: 1234

})

// or 

@Config('app.config.js')

// app.config.js

module.exports = {

  port: 1234

}

```

* all provided config items:

```js

{

  // port: 8080,

  // favicon: '',

  // staticOption: {

  //   root: 'static'

  // },

  // https: {

  //   key: '',

  //   cert: ''

  // },

  // onlisten(port) {

  //   console.log('an app listening on ' + port);

  // }

}

```

* **@Router[all|get|put|post|patch|del|delete](prefix, Object)**

we provide a very nice way to make your router Configurable & Combinable & Reusable, yeah, just a function mapping. see detail [koa-router-mapping](https://github.com/famanoder/koa-router-mapping);

let's define a api, eg: `/api/user/getUserInfo`.

we recommand every api is a function or an array of function. consider the following pseudocode example.

```js

async function getUserInfo($service, $helper) {

  const userInfo = await $service.getUserInfo(userId);

  $helper.success(userInfo);

}

// api path can be splited by '/'

@Router.get('api', {

  'user/getUserInfo': getUserInfo

})

class App extends Eryue {}

new App();

```

as you see, `getUserInfo` just a function and has injected two params `$service` and `$helper`, there is too many params can be injected to our **Router** function, eg: `$context`/`$next`/`$service`/`$helper` and so on, actually, this is very pure for our api definition. as you like, you can look it as controler! 

* **@Middlewares**

* **@Service**