{"id":23231845,"url":"https://github.com/tangilj/litama","last_synced_at":"2025-08-19T16:34:02.490Z","repository":{"id":56367069,"uuid":"308423346","full_name":"TangilJ/Litama","owner":"TangilJ","description":"WebSocket server for the Onitama board game.","archived":false,"fork":false,"pushed_at":"2022-10-15T17:07:31.000Z","size":71,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-13T16:27:30.876Z","etag":null,"topics":["board-game","mongodb","onitama","python","server","websocket"],"latest_commit_sha":null,"homepage":"https://litama.herokuapp.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TangilJ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-29T19:00:58.000Z","updated_at":"2023-05-21T22:42:49.000Z","dependencies_parsed_at":"2023-01-20T03:47:47.123Z","dependency_job_id":null,"html_url":"https://github.com/TangilJ/Litama","commit_stats":null,"previous_names":["tangilj/litama"],"tags_count":null,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TangilJ%2FLitama","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TangilJ%2FLitama/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TangilJ%2FLitama/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TangilJ%2FLitama/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TangilJ","download_url":"https://codeload.github.com/TangilJ/Litama/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230363947,"owners_count":18214718,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["board-game","mongodb","onitama","python","server","websocket"],"created_at":"2024-12-19T02:16:49.283Z","updated_at":"2024-12-19T02:16:49.831Z","avatar_url":"https://github.com/TangilJ.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Litama\nLitama is a WebSocket server for the Onitama board game written in Python. A live version of this is available at `wss://litama.herokuapp.com`. To make a client that communicates with this server, see the [wiki page](https://github.com/TheBlocks/Litama/wiki) on this repository. If you'd like to be able to run this server, follow the instructions below to get started.\n\n## Getting started\n\n### Prerequisites\n\n#### Python\n\nYou'll need Python 3.6 or higher to run Litama: https://www.python.org/downloads/\n\nYou'll also need to install Litama's dependencies. The requirements.txt file has all the dependencies listed. Install them with:\n\n```\npip install -r requirements.txt\n```\n\n#### MongoDB\n\nIf you want to run the database locally, you will need to install MongoDB. The free community version can be found here: https://www.mongodb.com/try/download/community\n\nAlternatively, you can run the database on the cloud. You may wish to look into MongoDB Atlas for free hosting of small projects: https://www.mongodb.com/cloud/atlas\n\n\nYou will also need to set up `MONGODB_HOST` as an environment variable. This should be a URI to the `mongod` instance.\nWhen running locally, it should look something like this: `mongodb://localhost:27017/`.\nIf you are using MongoDB Atlas, it will look similar to this: `mongodb+srv://username:password@clustername.abcde.mongodb.net/dbname`. If you are using MongoDB Atlas, visit the cluster page on the Atlas website to find the connection URI you should use.\n\nYou shouldn't need to set up the database manually. If you find issues with not being able to access or store data, make sure you have a database called `litama` with a collection called `matches`. Create this database if it was not created automatically and you are running into issues.\n\n\n### Running Litama\n\nYou need to run the `mongod` daemon before running Litama:\n```\nmongod.exe (on Windows)\nmongod (on Linux/macOS)\n```\nIf the executable can't be found, add it to your PATH or run it from the installation directory (usually `C:\\Program Files\\MongoDB\\Server\\4.x\\bin\\mongod.exe` on Windows).\n\nNow you should be ready to run Litama:\n```\ncd litama\npython server.py\n```\n\nBy default, the webpage can be found at `http://127.0.0.1:5000` and you can connect to the server with WebSocket at `ws://127.0.0.1:5000`.\n\n\n## Built with\n\n- [Python](http://python.org)\n- [Flask](https://github.com/pallets/flask)\n- [Flask-Sockets](https://github.com/heroku-python/flask-sockets)\n- [MongoDB](https://www.mongodb.com/)\n\n\n## License\n\nThis project is licensed under the Mozilla Public License Version 2.0. See the [LICENSE](https://github.com/TheBlocks/Litama/blob/master/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftangilj%2Flitama","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftangilj%2Flitama","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftangilj%2Flitama/lists"}