https://github.com/maksymignatiev/petpet_server
https://github.com/maksymignatiev/petpet_server
ansi bun cache hono honojs http http-server petpet sharp-js typescript
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/maksymignatiev/petpet_server
- Owner: MaksymIgnatiev
- License: 0bsd
- Created: 2024-09-26T13:36:08.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-03-17T21:46:18.000Z (about 1 month ago)
- Last Synced: 2025-04-10T23:52:23.382Z (19 days ago)
- Topics: ansi, bun, cache, hono, honojs, http, http-server, petpet, sharp-js, typescript
- Language: TypeScript
- Homepage:
- Size: 534 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PetPet HTTP server
## Petpet HTTP server written in TypeScript and Svelte.js, 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](https://bun.sh)
2. Follow instruction on how to install per operating system (GNU+Linux/Mac/Windows)
To use the server:
Clone the repo:
```sh
git clone https://github.com/MaksymIgnatiev/petpet_server.git
cd petpet_server
```
1. Install dependencies:
```sh
bun install
```
2. Run the projct:
```sh
bun start
```
2. To see help page:
```sh
# More preferable
bun run help
# or
bun start -h
```
> [!Note]
> To access the root endpoint `/` with regular HTML (home page, sort of), you need to install dependencies inside `svelte-app` directory, and run either in development mode or build the production code.
You can spesify runtime options in `config.toml` file in the root of the project, or with flags. Read [configuration.md](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](routes.md) file.
Information about cache can be found in [cache.md](cache.md) file.
## License
This project is licensed under the 0BSD License - see the [LICENSE](LICENSE) file for details.