https://github.com/MahjongRepository/mahjong-portal

Portal for russian riichi mahjong community
https://github.com/MahjongRepository/mahjong-portal

django hacktoberfest leaderboard mahjong python tournament

Last synced: 3 months ago
JSON representation

Portal for russian riichi mahjong community

• Host: GitHub
• URL: https://github.com/MahjongRepository/mahjong-portal
• Owner: MahjongRepository
• License: mit
• Created: 2017-12-15T04:53:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T23:07:11.000Z (3 months ago)
• Last Synced: 2024-04-06T00:22:17.451Z (3 months ago)
• Topics: django, hacktoberfest, leaderboard, mahjong, python, tournament
• Language: Python
• Homepage: https://mahjong.click/en/
• Size: 6.21 MB
• Stars: 13
• Watchers: 7
• Forks: 8
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• awesome-riichi - Riichi portal

README

        
The project is working with Python **3.6+** only.

It is web-application to accumulate, calculate and display russian riichi-mahjong tournaments and ratings.

## Local

### Project set up

You need to have installed docker and docker compose.

Steps to run the project:

1. `make build-docker`

2. `make initial-data` (run this command only once, for the initial project setup)

3. `make up`

After these steps you will be able to access website here: http://0.0.0.0:8060/

## Production

### Docker set up

You need to have installed docker and docker compose.

Copy `.envs/.production.env.example` file and fill it with real data, but don't forget to keep it in secret (at least don't add it to version control system). Assign these env variables to the container with any way that is suits you (there are different options how to do it), and after that you can simply run `make build` and `make up` commands. By default in `production.yml` we are using `.envs/.production.env` file.

For static files serving and SSL configuration you need to set up the server upfront of this docker image.

If needed, restore the database backup for the new installation.

### DB Backups

On your host machine you can set up these cron commands to make backups:

```

# every 6 hours

0 */6 * * * cd /root/portal/ && make db-backup backup_type=hourly && /root/upload_files.sh

# once a week

0 0 * * 0 cd /root/portal/ && make db-backup backup_type=weekly && /root/upload_files.sh

# once a month

0 0 2 * * cd /root/portal/ && make db-backup backup_type=monthly && /root/upload_files.sh

```