https://github.com/mono-js/mono
Minimalist Framework on top of Express.js
https://github.com/mono-js/mono
api express framework mono node rest
Last synced: about 1 month ago
JSON representation
Minimalist Framework on top of Express.js
- Host: GitHub
- URL: https://github.com/mono-js/mono
- Owner: mono-js
- License: mit
- Created: 2017-08-07T14:33:01.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-21T10:08:53.000Z (almost 7 years ago)
- Last Synced: 2025-04-20T05:06:52.530Z (2 months ago)
- Topics: api, express, framework, mono, node, rest
- Language: JavaScript
- Homepage: https://mono.js.org
- Size: 527 KB
- Stars: 160
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Mono is a minimalist REST API Framework on top of Express.js
[](https://www.npmjs.com/package/mono-core)
[](https://travis-ci.org/mono-js/mono)
[](https://codecov.io/gh/mono-js/mono)
[](https://github.com/mono-js/mono/blob/master/LICENSE)
## Documentation 📘
[https://mono.js.org](https://mono.js.org)
## Features ✨
- Environment based config
- API Versioning (`v1`, `v2`...)
- [Json Web Token](https://jwt.io) sessions
- ACL with [Imperium](https://github.com/mono-js/imperium)
- Routes validation with [joi](https://github.com/hapijs/joi)
- Init files via `src/**/*.init.js`
- Routes declaration via `src/**/*.routes.js`
- Extendable with modules & hooks
## Usage 🤸
**INFO:** You need `node` >= `8.0.0` to use Mono since it uses native `async/await`
### Installation
You can boostrap a Mono project by using our official [create-mono-app](https://github.com/mono-js/create-mono-app):
```bash
npx create-mono-app my-app
```
### Start in development
```bash
npm run dev
```
### Start in production
```bash
NODE_ENV=production npm start
```
### Run the tests with coverage
```bash
npm test
```
## Official Modules 📦
Mono offers a module system to plug any functionality in your project:
- [mono-mongodb](https://github.com/mono-js/mono-mongodb)
- [mono-elasticsearch](https://github.com/mono-js/mono-elasticsearch)
- [mono-redis](https://github.com/mono-js/mono-redis)
- [mono-io](https://github.com/mono-js/mono-io)
- [mono-push](https://github.com/mono-js/mono-push)
- [mono-mail](https://github.com/mono-js/mono-mail)
- [mono-notifications](https://github.com/mono-js/mono-notifications)
- [mono-doc](https://github.com/mono-js/mono-doc)
## Credits 🙏
Logo created by Frederick Allen from the Noun Project.
## License 👀
MIT © [mono-js](https://github.com/mono-js)