https://github.com/projectborealis/pb-api
Project Borealis web services API
https://github.com/projectborealis/pb-api
Last synced: 4 months ago
JSON representation
Project Borealis web services API
- Host: GitHub
- URL: https://github.com/projectborealis/pb-api
- Owner: ProjectBorealis
- Created: 2024-07-27T19:41:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-09T00:10:10.000Z (over 1 year ago)
- Last Synced: 2025-05-05T05:35:30.324Z (about 1 year ago)
- Language: TypeScript
- Size: 86.9 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Borealis API
Project Borealis web services API for the game, admin panel, developer services, and website.
## Project structure
1. Your main router is defined in `src/index.ts`.
2. Each endpoint has its own file in `src/endpoints/`.
3. For more information read the [chanfana documentation](https://chanfana.pages.dev/) and [Hono documentation](https://hono.dev/docs).
## Development
1. Clone this project and install dependencies with `pnpm install`
2. Run `pnpm dev` to start a local instance of the API.
3. Open `http://localhost:8787/` in your browser to see the Swagger interface where you can try the endpoints.
4. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.
## Deployment
Run `pnpm deploy` to publish the API to Cloudflare Workers.