About this Project
This is an online mahjong application experimenting with Flask-SocketIO to allow communication between server and user in realtime to conduct multiplayer games. The GUI and text of this project are all written in Japanese. Most of the terms used referring to MahJong concepts are Japanese.
Built with:
- Flask
- Flask-SocketIO
- javascript SocketIO
- SQLAlchemy
- PostgreSQL
- bootstrap
- jquery
Getting Started
Prerequisites: You must have a hosting acount such as Heroku or Azure to host this software.
Steps for Heroku: 0. clone this repository locally
- Login or register
- From dashboard navigate to create new application
- Enter app name and other config
- install Heroku CLI (https://devcenter.heroku.com/articles/heroku-command-line)
- login to heroku from prompt $ heroku login
- add heroku SQL with commands below $ heroku addons:create heroku-postgresql:
- get the database address with the following command $ heroku config
- change the database url to a format compatible with SQLAlchemy Ex. postgres://foo:foo@heroku.com:5432/hellodb -> postgresql://foo:foo@heroku.com:5432/hellodb
- add the adjusted database url to flask app config in init.py app.config['SQLALCHEMY_DATABASE_URI'] = postgresql://foo:foo@heroku.com:5432/hellodb
- cd to the location of local repository in prompt
- input following command $ git init $ heroku git:remote -a YOUR_APP_NAME_HERE $ git add . $ git commit -am "YOUR NOTE HERE" $ git push heroku master
- Then you should have this app running!
Steps for Google Cloud
- Create a new Project in Google Cloud
- Open console
- Clone this git using git cli $ git https://github.com/inoueaus/pymahjong/ -b google-cloud-version
- cd to the cloned repository $ cd pymahjong
- Deploy app using gcloud $ gcloud app deploy
- You're good to go!
Usage
This project acts as an example of how you can use SocketIO to have users directly interact with a server and implement interactive usage of Python with user interface. Feel free to adapt it or improve it as you see fit.
Playing:
- create account
- navigate to game paginate
- click 一人で遊ぶ to play one player
Roadmap
I plan on improving the userinterface of the game and of course getting rid of remaining (yet to be found) bugs. I need better understanding of Javascript to do this. Also, there are known issues posted in the open issues section of this git. The point calculation system is still very buggy.
Contributing
You are more than welcome to build upon the code I have here! Please create a new branch before doing so.
License
Distributed under the MIT license.
Acknowledgements
I relied heavily on Miguel Grinbergs Flask-SocketIO and examples he provides.