https://github.com/iandesuyo/randosoru-server
Backend of guild.randosoru.me, a website for saving clan battle records
https://github.com/iandesuyo/randosoru-server
fastapi princess-connect-redive python
Last synced: about 1 year ago
JSON representation
Backend of guild.randosoru.me, a website for saving clan battle records
- Host: GitHub
- URL: https://github.com/iandesuyo/randosoru-server
- Owner: IanDesuyo
- Created: 2020-05-31T17:07:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-14T22:18:18.000Z (over 3 years ago)
- Last Synced: 2025-04-23T02:13:18.241Z (about 1 year ago)
- Topics: fastapi, princess-connect-redive, python
- Language: Python
- Homepage: https://guild.randosoru.me
- Size: 55.7 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Randosoru-Server
Backend of guild.randosoru.me
## Getting Started
### Prerequisites
* MySQL Server
* [Discord OAuth2 App](https://discord.com/developers/applications)
* [Line Login App](https://developers.line.biz/en/)
### Installation
1. Install all required modules from pip. `pip3 install -r requirements.txt`
2. Rename `config.py.example` to `config.py` and modify it.
## Deployment
#### Behind a Proxy
If you are using Nginx or any proxy server, add the following rules to your config.
```conf
location /api/ {
proxy_pass http://{SERVER_IP}/;
}
location /socket.io {
proxy_pass http://{SERVER_IP};
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header Host $host;
}
```
#### Without Docker
Run `uvicorn main:app --host 0.0.0.0 --port 80` to start a server at `0.0.0.0:80`.
#### With Docker
If your MySQL server is a docker container, you may need to add `--net mysql-network` when using `docker run`.
```
docker build . -t guild-randosoru-server
docker run \
-e VIRTUAL_HOST=guild.randosoru.me \ # for nginx-proxy
--restart always \
--name guild-randosoru-server \
-d guild-randosoru-server
```