maestroserver/audit-app-maestro repository overview

⁠Maestro Server - Audit App

Audit App is webapp application port of Maestro Server stack, yours responsibility is:

• Control and manage changed data on Maestro
• Show a tree of changed entities
• Store and control data changes
• Trigger hooks based in changed rules

We using DDD to organize the code, has infra, repositories, entities (values objects), interfaces, application, and domain.

Constructed with KrakenJs, we create a lot of middleware and organize by domain.

Core API, organized by modules:

• Core
• Authetication
• Audit

⁠TechStack

• NodeJs 8.11.
• MongoDB 3.6

⁠Service relations

• Maestro Server App
• Data App

⁠Setup

⁠Installation by docker

docker run -p 10900:10900  -e "MAESTRO_MONGO_URI=mongodb" -e "MAESTRO_MONGO_DATABASE=maestro-audit"  maestroserver/audit-maestro

Or by docker-compose

version: '2'

services:
    server:
    image: maestroserver/audit-maestro
    ports:
    - "10900:10900"
    environment:
    - "MAESTRO_MONGO_URI=mongodb"
    - "MAESTRO_MONGO_DATABASE=maestro-audit"

⁠Dev Env

Configure database and port application in .env file

MAESTRO_PORT=10900
MAESTRO_MONGO_URI='localhost'
MAESTRO_MONGO_DATABASE='maestro-audit'

Development

Install nodejs, version above 7.6, and mongodb need to be running.

npm install
npm run server

Run all tests or any test type

mocha test/**/*js --reporter spec

gulp test_e2e
gulp test_unit
gulp eslint

⁠Env variables

⁠Contribute

Are you interested in developing Maestro Server, creating new features or extending them?

We created a set of documentation, explaining how to set up your development environment, coding styles, standards, learn about the architecture and more. Welcome to the team and contribute with us.

See our developer guide⁠