Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 1.59 KB

README.md

File metadata and controls

108 lines (73 loc) · 1.59 KB
Raw

Welcome to the OBP API Explorer II

ABOUT

This application is used to explore OBP APIs and interact with the data and services in the context of the logged in user.

This application will gradually replace the original API Explorer. Long live the API Explorer!

Install the Prerequisite Software

  • required: { node: >=16.14 }
  • required: { npm: >=8.0.0 }

Development Project Setup

  • Setup your .env file (see .env.example)
Install dependencies
yarn install

or

npm install
Compile and Hot-Reload for Development
yarn dev

or

npm run dev
Run Unit Tests with Vitest
yarn test:unit

or 

npm test:unit

Compile and Minify for Production

Build
npm run build
Build Server
npm run build-server
Start the backend server
npx ts-node <path-to-your-install>/server/app.js
Check the status of API-Explorer II back-end
Please find a message at a log file similar to this one:

Backend is running. You can check a status at http://localhost:8085/api/status

and use the link to check the status
Nginx deployment
server {
    # Frontend
    location / {
        root    /path_to_dist/dist;
        try_files $uri $uri/ /index.html;
    }
    
    # Proxy API
    location /api {
        proxy_pass http://localhost:8085;
    }
}

LICENSE

This project is licensed under the AGPL V3 (see NOTICE) and a commercial license from TESOBE.