README.md
[](https://codeclimate.com/github/maestro-server/analytics-front) [](https://travis-ci.com/maestro-server/analytics-front) [](https://codeclimate.com/github/maestro-server/analytics-front)
[](https://www.codacy.com/gh/maestro-server/analytics-front/dashboard?utm_source=github.com&utm_medium=referral&utm_content=maestro-server/analytics-front&utm_campaign=Badge_Grade)
[](https://coveralls.io/github/maestro-server/analytics-front?branch=master)
# Maestro Server #
Maestro Server is an open source software platform for management and discovery servers, apps and system for Hybrid IT. Can manage small and large environments, be able to visualize the latest multi-cloud environment state.
### Demo ###
To test out the demo, [Demo Online](http://demo.maestroserver.io "Demo Online")
## Documentation ##
* [UserGuide](http://docs.maestroserver.io/en/latest/userguide/cloud_inventory/inventory.html "User Guide")
* [API Contract](https://maestro-server.github.io/analytics-front/inventory/index.html "API Contract")
# Maestro Server - Analytics Front #
Analytics Front Application is accountable to expose diagrams to the user:
* Public/private authorization
* Expose svgs diagrams
* Upload private SVGs
Constructed with KrakenJs, we create a lot of middleware and organize by domain.
**Core API:**
* Core
* Authetication
* Graph
## TechStack ##
* NodeJs 8.11.
* MongoDB 3.4
* RabbitMQ
* AWS S3 (If using S3 upload)
## Connect to: ##
* Maestro Analytics
* Maestro Server App
* Data App
## Setup ##
#### Installation by docker ####
```bash
docker run -p 9999:9999 -e "MAESTRO_MONGO_URI=mongodb://mongodb" -e "MAESTRO_MONGO_DATABASE=maestro-client" maestroserver/analytics-front-maestro
```
Or by docker-compose
```bash
version: '2'
services:
server:
image: maestroserver/analytics-front-maestro
ports:
- "9999:9999"
environment:
- "MAESTRO_MONGO_URI=mongodb://mongodb"
- "MAESTRO_MONGO_DATABASE=maestro-client"
```
#### Dev Env ####
Configure database and port application in .env file
```bash
MAESTRO_PORT=9999
MAESTRO_MONGO_URI='mongodb://localhost'
MAESTRO_MONGO_DATABASE='maestro-client'
```
Development
Install nodejs, version above 7.6, and mongodb need to be running.
```bash
npm install
npm run server
```
Run all tests or any test type
```bash
mocha test/**/*js --reporter spec
gulp test_e2e
gulp test_unit
gulp eslint
```
### Env variables ###
| Env Variables | Example | Description |
|------------------------------|--------------------------|--------------------------------------------|
| MAESTRO_PORT | 9999 | |
| API_URL | http://localhost:8888 | Server app Url |
| NODE_ENV | development|production | |
| MAESTRO_MONGO_URI | mongodb://localhost | DB string connection |
| MAESTRO_MONGO_DATABASE | maestro-client | Database name |
| | | |
| MAESTRO_SECRETJWT | XXXX | Secret key - session |
| MAESTRO_WEBSOCKET_SECRET | XXXX | Secret Key - JWT Websocket connections |
| MAESTRO_SECRETJWT_PRIVATE | XXX | Secret Key - JWT private connections |
| MAESTRO_NOAUTH | XXX | Secret Pass to validate private connections|
| MAESTRO_SECRETJWT_PUBLIC | XXXX | Secret key - same server app |
| | | |
| AWS_ACCESS_KEY_ID | XXXX | |
| AWS_SECRET_ACCESS_KEY | XXXX | |
| AWS_DEFAULT_REGION | us-east-1 | |
| AWS_S3_BUCKET_NAME | maestroserver | |
| MAESTRO_UPLOAD_TYPE | S3/Local | Upload mode |
| LOCAL_DIR | /artifacts | Where files will be uploaded |
| MAESTRO_TMP | $rootDirectory | PWD process |
| ANALYTICS_URL | " | Application base URL |
### 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](http://docs.maestroserver.io/en/latest/contrib.html)
### Contact ###
We may be able to resolve support queries via email. [Please send me a message here](https://maestroserver.typeform.com/to/vf6sGR)
### Donate ###
I have made Maestro Server with my heart, think to solve a real operation IT problem. Its not easy, take time and resources.
The donation will be user to:
- Create new features, implement new providers.
- Maintenance libs, securities flaws, and technical points.
<a href="https://www.buymeacoffee.com/9lVypB7WQ" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
### Sponsor ###
[<img src="docs/_imgs/jetbrains.png" width="100">](https://www.jetbrains.com/?from=maestroserver)