Skip to content

owlebot/open-api

Repository files navigation

open-api

API to interact with the owlebot system.
To access the API and start using it, join our discord server and ask for a token.

Setup

Node version: Node v18+

Requirements:
Copy .env.defaults as .env.
Override the necessary keys.

Install dependencies:
yarn

Start application:
yarn start

Start application with hot reload:
yarn start:watch

Start application in debug mode:
yarn start:debug

Features

Endpoints

  • Get route
    GET /route
    String

  • Get subroute
    GET /route/subroute
    String

Contributions

Feel free to contribute to this project by opening PRs or Issues. Contributions are always welcome.
To know more about contributions, discuss the development or get help, you can join our discord server here.