mirror of
https://github.com/dadosfera/maestro.git
synced 2026-11-18 09:19:09 +00:00
DOCS: Added proper readme
This commit is contained in:
@@ -1,4 +1,50 @@
|
||||
# Maestro
|
||||
<p align="center">
|
||||
<image src="./assets/maestro.svg" style="width:10rem">
|
||||
<h1 align="center">Maestro</h1>
|
||||
</p>
|
||||
</p>
|
||||
This is the Dadosfera´s gateway repository, it´s responsable for the communication between frontend application and Dadosfera´s mirosservices.
|
||||
|
||||
## 💻 Requirements
|
||||
|
||||
Before you start, make sure you have done the following steps:
|
||||
|
||||
* Installed Nodejs version 16.14.2
|
||||
* Installed latest NPM version
|
||||
|
||||
|
||||
|
||||
## 🚀 Installing Maestro
|
||||
|
||||
First of all clone the repository:
|
||||
* SSH:
|
||||
```
|
||||
git clone git@github.com:dadosfera/maestro.git
|
||||
```
|
||||
* HTTPS:
|
||||
```
|
||||
git clone git@github.com:dadosfera/maestro.git
|
||||
```
|
||||
|
||||
## Enviroment variables
|
||||
|
||||
Here is a list of enviroment variables needed in order to run the application correctly.
|
||||
|
||||
```
|
||||
ENV=
|
||||
DUC_URL=
|
||||
INFACTORY_URL=
|
||||
TRFACTORY_URL=
|
||||
OTFACTORY_URL=
|
||||
PIFACTORY_URL=
|
||||
JWT_PRIVATE_KEY=
|
||||
AWS_IDENTITY_POOL_ID=
|
||||
```
|
||||
|
||||
## Running Maestro
|
||||
|
||||
In order to run Maestro just run the following command:
|
||||
```
|
||||
npm run start:dev
|
||||
```
|
||||
If everything is fine the Maestro will start and be ready to receive HTTP requests
|
||||
Reference in New Issue
Block a user