blob: baf16c11b7dede4468fc81ad691f320251b9834e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
<p align="center">
<h1>senpy-api</h1>
</p>
<p align="center">
<a href="https://discord.com/invite/yWKgRT6">
<img src="https://img.shields.io/discord/246524734718738442" alt="discord" />
</a>
<a href="https://www.codefactor.io/repository/github/senpy-club/api">
<img src="https://www.codefactor.io/repository/github/senpy-club/api/badge" alt="codefactor" />
</a>
<a href="https://saythanks.io/to/[email protected]">
<img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" alt="Say Thanks" />
</a>
<a href="./license">
<img src="https://img.shields.io/github/license/senpy-club/api" alt="license" />
</a>
</p>
## nix
- build: `nix-build`
- docker: `nix-build docker.nix`
## usage (without docker)
- run (dev): `cargo run`
also note that this api wrapper leverages the official github api, meaning that rate-limits are
very much present.
if you are going to be self hosting this project, it is highly encouraged that
you generate yourself a github personal access token and set the environment variable `GITHUB_TOKEN`
as your pat.
## contributing
please reference the [contribution guidelines](./contributing.md) of this repository.
### license
[gnu general public license v3.0](https://github.com/senpy-club/api/blob/main/license)
|