# Open Tree Hole Backend
Backend of OpenTreeHole ---- Anonymous BBS for college students
## Features
- White-listed registration ---- for certain community like college students
- Anonymous: RSA encrypted personal information(email) and random identity
- Compliance: report, mute, ban, fold NSFW contents
- Push notifications: web(websocket), iOS and Android
- Balance between performance and development efficiency: stress test 300~400 qps
## Install
This installation is just for backend program. If you want to deploy the whole OpenTreeHole project, please visit [Deploy Repo](https://github.com/OpenTreeHole/deploy).
This project continuously integrates with docker. Go check it out if you don't have docker locally installed.
```shell
docker run -d -p 80:80 shi2002/open_tree_hole_backend
```
Note: this project is runnable with zero-configurations, for full configuration, visit [Configuration Doc](https://github.com/OpenTreeHole/deploy/wiki/配置文档).
## Usage
Please refer to [API Docs](https://github.com/OpenTreeHole/backend/wiki/API-文档).
## Badge
[](https://github.com/OpenTreeHole/backend/actions/workflows/master.yaml)
[](https://github.com/OpenTreeHole/backend/actions/workflows/dev.yaml)
[](https://github.com/OpenTreeHole/backend/stargazers)
[](https://github.com/OpenTreeHole/backend/issues)
[](https://github.com/OpenTreeHole/backend/pulls)
[](https://github.com/RichardLitt/standard-readme)
### Powered by
## Contributing
Feel free to dive in! [Open an issue](https://github.com/OpenTreeHole/backend/issues/new) or submit PRs.
Full contributing docs and requirements is available at [wiki](https://github.com/OpenTreeHole/backend/wiki/开发).
### Contributors
This project exists thanks to all the people who contribute.
<a href="https://github.com/OpenTreeHole/backend/graphs/contributors">
<img src="https://contrib.rocks/image?repo=OpenTreeHole/backend" />
</a>
## Licence
[](https://github.com/OpenTreeHole/backend/blob/dev/LICENSE)
© OpenTreeHole
Open Tree Hole 的后端项目.zip （71个子文件） 
backend-master .github ISSUE_TEMPLATE 
enhancement-request.md 202B question.md 114B feature_request.md 612B bug_report.md 602B workflows test.yaml 776B dev.yaml 1KB master.yaml 1KB Pipfile 533B LICENSE 11KB tests __init__.py 0B
image.jpg 943KB test_async.py 2KB test_apis.py 31KB api __init__.py 0B migrations __init__.py 0B 0004_hole_hidden.py 411B 0001_initial.py 7KB 0006_auto_20220122_2227.py 458B 0005_activeuser.py 618B 0009_floor_storey.py 378B 0002_floor_special_tag.py 385B 0007_auto_20220123_1646.py 381B 0008_auto_20220123_1827.py 413B 0010_auto_20220203_1055.py 384B 0011_auto_20220325_0954.py 1KB 0003_olduserfavorites.py 568B serializers.py 17KB apps.py 222B models.py 7KB api.py 34KB urls.py 2KB signals __init__.py 215B funcs.py 5KB tasks.py 5KB utils __init__.py 0B my_auth.py 2KB apis.py 2KB permissions.py 3KB exception.py 817B default_values.py 1KB auth.py 2KB decorators.py 513B constants.py 352B notification.py 5KB names.json 13KB throttles.py 221B name.py 1015B start.py 883B gconfig.py 778B treehole_demo_private.pem 3KB manage.py 668B start.sh 156B Dockerfile 800B .gitignore 71B ws utils.py 1KB __init__.py 0B middleware.py 1KB urls.py 159B notification.py 3KB treehole_demo_public.pem 799B OpenTreeHole __init__.py 232B development.py 1KB testing.py 343B production.py 2KB wsgi.py 401B urls.py 152B celery.py 727B settings.py 3KB asgi.py 734B config.py 6KB README.md 3KB资源评论
