Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.07 KB

README.md

File metadata and controls

43 lines (31 loc) · 1.07 KB

Petpet HTTP server

Petpet HTTP server written in TypeScript, supported with Bun.js, Hono, Sharp.js, and Gifwrap

First of all, you need a Bun runtime to run this project.

To install Bun:

  1. Head over to Bun's official website
  2. Follow instruction on how to install per operating system (GNU+Linux/Mac/Windows)

To use the server:

Clone the repo:

git clone https://github.com/MaksymIgnatiev/petpet_server.git

Install dependencies:

bun install

Run the projct:

bun start

To see help page:

# More preferable
bun run help
# or
bun start -h

You can spesify runtime options in config.toml file in the root of the project, or with flags. Read configuration.md file for more, or see the help page with available flags.
There are different routes available. Documentation can be found in routes.md file.
Information about cache can be found in cache.md file.

License

This project is licensed under the 0BSD License - see the LICENSE file for details.