API Explorer II
Go to file
2023-06-05 22:32:54 +02:00
.vscode WIP: API-Explorer-II 2023-03-29 23:22:33 +08:00
public REFACTOR: url path and external links 2023-05-08 17:08:04 +08:00
server FIX: log off 2023-06-05 23:39:20 +08:00
src REFACTOR: preview language 2023-06-02 23:09:17 +08:00
.env.example FIX: home page, login username 2023-05-25 05:57:08 +08:00
.eslintrc.cjs REFACTOR: moved obp client to backend 2023-05-04 01:17:01 +08:00
.gitignore REFACTOR: prod dist package and dist 2023-05-05 15:09:16 +08:00
.prettierrc.json WIP: API-Explorer-II 2023-03-29 23:22:33 +08:00
auto-imports.d.ts REFACTOR: form notification 2023-06-02 23:03:55 +08:00
components.d.ts REFACTOR: form notification 2023-06-02 23:03:55 +08:00
env.d.ts WIP: API-Explorer-II 2023-03-29 23:22:33 +08:00
index.html REFACTOR: url path and external links 2023-05-08 17:08:04 +08:00
NOTICE Create NOTICE 2023-05-08 14:30:05 +02:00
package.json REFACTOR: form notification 2023-06-02 23:03:55 +08:00
README.md docfix/Update README.md 2023-06-05 17:20:28 +02:00
tsconfig.app.json WIP: styling and authentication 2023-04-20 14:04:46 +08:00
tsconfig.json WIP: styling and authentication 2023-04-20 14:04:46 +08:00
tsconfig.node.json WIP: styling and authentication 2023-04-20 14:04:46 +08:00
tsconfig.server.json REFACTOR: url path and external links 2023-05-08 17:08:04 +08:00
tsconfig.vitest.json WIP: styling and authentication 2023-04-20 14:04:46 +08:00
vite.config.ts REFACTOR: moved obp client to backend 2023-05-04 01:17:01 +08:00
vitest.config.ts WIP: API-Explorer-II 2023-03-29 23:22:33 +08:00
yarn.lock REFACTOR: form notification 2023-06-02 23:03:55 +08:00

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.

Development Project Setup

  • Setup your .env (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
Lint with ESLint
yarn lint

or

npm lint
Format with Prettier
yarn format

or

npm format

Compile and Minify for Production

Build the frontend
yarn build

or

npm build
Build the backend
yarn build-server

or

npm build-server
Start the backend server
your-absolute-path-to-server-dist> node app.js
Nginx deployment
server {
    # Frontend
    location / {
        root    /your_absolute_path_to_dist/dist;
        try_files $uri $uri/ /index.html;
    }
    
    # Proxy API
    location /api {
        proxy_pass http://localhost:8085;
    }
}
nginx -s reload //Restart your nginx

LICENSE

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