diff options
| author | Fuwn <[email protected]> | 2024-01-19 19:22:43 -0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-01-19 19:22:43 -0800 |
| commit | 3c047518c143a03d65ee6338defd58ec6f509df0 (patch) | |
| tree | 780a2400cf5bb77f4453e73284e663d9b94f8cc5 /README.md | |
| parent | docs(readme): simplify (diff) | |
| download | counter-3c047518c143a03d65ee6338defd58ec6f509df0.tar.xz counter-3c047518c143a03d65ee6338defd58ec6f509df0.zip | |
docs(readme): rename
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0749fbc --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# ☗ Counter + +> 多种风格可选的萌萌计数器 + +<img src="https://counter.due.moe/get/@counter.github?theme=urushi" width="50%"> + +## Installation + +### Self-hosting + +```shell +$ git clone https://github.com/Fuwn/counter.git +$ cd counter +$ yarn install +$ yarn start +``` + +### Configuration + +```yaml +# config.yml + +app: + # site: https://counter.due.moe + port: 3000 + +db: + type: sqlite # sqlite, mongodb +``` + +#### MongoDB + +Expose a `DB_URL` environment variable + +```shell +export DB_URL=mongodb+srv://user:passwd@***.***.***.mongodb.net/db_count +``` + +### Resource Attributions + +* [A-SOUL_Official](https://space.bilibili.com/703007996) +* [Moebooru](https://github.com/moebooru/moebooru) +* [Rule 34](https://rule34.xxx) (NSFW) +* [Gelbooru](https://gelbooru.com) (NSFW) + +### License + +This project is licensed with the [MIT License](LICENSE). + |