Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wisersolutions/quadro
Server-side framework for building services
https://github.com/wisersolutions/quadro
framework ioc microservices nodejs opinionated-framework quadro-framework rest web
Last synced: about 1 month ago
JSON representation
Server-side framework for building services
- Host: GitHub
- URL: https://github.com/wisersolutions/quadro
- Owner: WiserSolutions
- License: mit
- Created: 2017-02-27T22:07:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T20:20:31.000Z (about 1 year ago)
- Last Synced: 2024-04-14T19:04:57.903Z (8 months ago)
- Topics: framework, ioc, microservices, nodejs, opinionated-framework, quadro-framework, rest, web
- Language: JavaScript
- Homepage:
- Size: 2.81 MB
- Stars: 7
- Watchers: 33
- Forks: 13
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Quadro framework
[](https://codeclimate.com/github/WisePricer/quadro)
[](https://circleci.com/gh/WisePricer/quadro)
[](https://www.bithound.io/github/WisePricer/quadro/master/dependencies/npm)
TOC:
- [Quadro framework](#quadro-framework)
- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration manager](#configuration-manager)
- [Environment-specific configuration](#environment-specific-configuration)
- [Local configuration:](#local-configuration)
- [Tests runner](#tests-runner)
## Requirements
- See `.nvmrc` in the root of the project for Node version requirements and if possible use NVM to install Node.
## Installation
Create a new app and add the following to package.json:
```json
"dependencies": {
"quadro": ""
}
```
In `app.js` add:
```js
const Quadro = require('quadro')
Quadro()
```
You're done! Run with:
```sh
node app.js [--watch]
```
Test with:
```sh
node app.js test [--watch]
```
## Configuration manager
Config files should be placed in `ROOT/config/` dir.
To get value of `key.nestedKey` in configuration file named `config/someConfig.yml`:
```js
app.config.someConfig.key.nestedKey
```
For safe configuration fetch, use `config.get`:
```js
app.config.get('someConfig.key.nestedKey')
```
To get value of `key.nestedKey` in `config/someConfig.yml|yaml|js|json` and
defaults to `3000` if such key doesn't exist
```js
app.config.get('someConfig.key.nestedKey', 3000)
```
### Environment-specific configuration
Quadro will load configuration from these paths (in the following order):
- config/
- config/$NODE_ENV
- config/local
Note: $NODE_ENV - is the NODE_ENV environment variable value
Configurations are merged while loading. In the following example:
```
|-- config/quadro.yml
|- dev/quadro.yml
|- local/quadro.yml
```
Configuration keys from `local/quadro.yml` will override keys from `dev/quadro.yml`
which in turn will override keys from `config/quadro.yml`.
#### Local configuration:
It is highly recommended that any config values that are tweaked during debugging/development
will be added to `local/` configs. This way you can add `**/config/local/` to `.gitignore`
and be able to keep your dev environment clean during commits/pushes.
You can maintain your local-machine specific configuration config/local.
For git to ignore those changes use:
```sh
git update-index --skip-worktree **/config/local/*
```
## Tests runner
To run tests use:
```sh
node app.js test
```
To make tests re-run on file changes use:
```sh
node app.js test --watch
```
# Contributing
Commit messages should be according to https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular
In short:
```
feat(ci): implemented a feature in CI
fix(pubsub): retries on rabbitmq disconnect
perf(http): HTTP performance improvements
docs(...): ...
refactor(...): ...
test(...): ...
chore(...): ...
```