https://github.com/owlebot/open-api
Public API to interact with the owle.bot app
https://github.com/owlebot/open-api
api javascript nodejs open-source openapi typescript
Last synced: 6 months ago
JSON representation
Public API to interact with the owle.bot app
- Host: GitHub
- URL: https://github.com/owlebot/open-api
- Owner: owlebot
- Created: 2023-09-01T15:59:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T09:51:20.000Z (about 1 year ago)
- Last Synced: 2024-11-28T10:33:34.145Z (about 1 year ago)
- Topics: api, javascript, nodejs, open-source, openapi, typescript
- Language: TypeScript
- Homepage: https://api.owle.bot
- Size: 238 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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+](https://nodejs.org/en/download/)
**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](discord.com).