What projects can be automated

1. Project have to be node/npm project (its only requirement to allow this automation be run)
2. Scripts (if needed) should save output files in one directory which is easly accessible for manager
3. Also should have some scripts to be run

Start guide (with docker):

1. Pull API git clone https://github.com/autonomous-node-projects/manager-api.git
2. Pull UI git clone https://github.com/autonomous-node-projects/manager-ui.git
3. Edit manager-api/env/.env.prod and manager-ui/src/environments/environment.prod.ts
4. Go to ./manager-api/docker directory and edit .env file
5. In the same directory run both docker-compose build and docker-compose up -d
6. Access ANPM from web browser under given host

Standalone Start guide:

1. Create mongo database for Autonomous node projects manager
2. Pull project to local directory
3. Run npm install
4. Edit environment file accordingly to your needs under - ./env/.env.prod (or while developing app - ./env/.env.dev)

API_PORT=3000
PROJECTS_FILES='data/projects_files'
TMP_FILES='data/tmp_files'
DB_URL='mongodb://localhost:27017'
DB_DB='ANPM'

5. Create TAR archive of your node root files (those among package.json)
6. Upload this TAR archive file to projects_files directory via ${API_IP}/projects (eg. http://localhost:3000/projects) endpoint
7. Schedule any script you want to run by via ${API_IP}/schedules?id={projectId}(eg. http://localhost:3000/schedules?id=608d79d77a728a50231001ac) endpoint using body:

[
    {
        "scriptName": "start",
        "every": {
            "value": 2,
            "timeType": "hours"
        },
        "exitAfter": 5
    }
]

Keys values:

• scriptName - script which will be run
  
• every.value - amount of time used as interval
  
• every.timeType - type of time used as interval
  
• exitAfter - amount of how many times script should be run and then terminated

8. Download output data via ${API_IP}/output?type=download endpoint

API Documentation

There is swagger viewer of Open API documentation under ${API_IP}/swagger.