moonshard

Nodejs framework to build high-performance app in no time

Introduction

MoonShard was created to improve the development phase and bring high-performance in production environments. It's easy to start, to use and deploy.

Features:

• Provide CLI and project scaffolding.
• Logs works and rotate file per day.
• Auto generate api-docs.
• Typescript first-class support.
• Full tested.
• Easy deployment to classic server, dockers, serverless or wired into microservices.

Installation

yarn create create-moonshard my-app

Manual Installation

1. Install the npm package

yarn add moonshard

1. TypeScript configuration: Make sure you are using TypeScript version 3.3 or higher, and you have enabled the following settings in tsconfig.json:

"emitDecoratorMetadata": true,
"experimentalDecorators": true,

Documentation

To check out guides, api documentation and examples, visit moonshard docs.

New Features and Issues

You can help to improve MoonShard by create issues for new features or reporting bugs

Changelog

Detailed changes for each release are documented in the release notes.

Contributions

Please make sure to read the Contributing Guide before making a pull request. Thank you to all the people who already contributed to MoonShard!

Guide for Developers

1. Get the repo and install dependencies

$ git clone https://github.com/cervantes/moonshard.git
$ cd moonshard
$ yarn install

1. Available scripts

$ yarn dev
$ yarn build
$ yarn lint
$ yarn test
$ yarn test:coverage
$ yarn docs:dev

License

MIT

© Copyright 2020 Cervantes