{"id":22690984,"url":"https://github.com/humanoidsandvichdispenser/availabili.tf","last_synced_at":"2026-04-13T20:31:36.628Z","repository":{"id":262900909,"uuid":"888153496","full_name":"HumanoidSandvichDispenser/availabili.tf","owner":"HumanoidSandvichDispenser","description":"Schedule and availability system for Team Fortress 2 teams","archived":false,"fork":false,"pushed_at":"2025-03-11T04:11:59.000Z","size":1340,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T05:20:45.473Z","etag":null,"topics":["flask","vue3","vuejs"],"latest_commit_sha":null,"homepage":"https://availabili-tf.sandvich.xyz","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HumanoidSandvichDispenser.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-13T22:53:17.000Z","updated_at":"2025-03-11T04:12:02.000Z","dependencies_parsed_at":"2024-12-20T03:20:30.445Z","dependency_job_id":"30ae3fe8-eb9a-4293-8203-f10a1224df3d","html_url":"https://github.com/HumanoidSandvichDispenser/availabili.tf","commit_stats":null,"previous_names":["humanoidsandvichdispenser/availabili.tf"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanoidSandvichDispenser%2Favailabili.tf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanoidSandvichDispenser%2Favailabili.tf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanoidSandvichDispenser%2Favailabili.tf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanoidSandvichDispenser%2Favailabili.tf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HumanoidSandvichDispenser","download_url":"https://codeload.github.com/HumanoidSandvichDispenser/availabili.tf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246215825,"owners_count":20741894,"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":["flask","vue3","vuejs"],"created_at":"2024-12-10T01:08:59.991Z","updated_at":"2026-04-13T20:31:36.613Z","avatar_url":"https://github.com/HumanoidSandvichDispenser.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# availabili.tf\n\nSchedule and availability system for Team Fortress 2 teams.\n\n## Tech Stack\n\n- **Frontend:** [Vue 3](https://v3.vuejs.org/) + TypeScript\n    - **State Management:** [Pinia](https://pinia.vuejs.org/)\n- **Backend:** [Flask](https://flask.palletsprojects.com/) + Python\n    - **ORM:** [SQLAlchemy](https://www.sqlalchemy.org/)\n    - **Validation:** [Pydantic](https://pydantic-docs.helpmanual.io/)\n    - [spectree](https://spectree.readthedocs.io/en/latest/index.html) for\n      OpenAPI documentation\n    - [Flask-Migrate](https://flask-migrate.readthedocs.io/en/latest/)\n      (Alembic) for database migrations\n    - [Celery](https://docs.celeryproject.org/en/stable/) for async and\n      scheduled tasks\n    - [Redis](https://redis.io/) for Celery broker\n- **Database:** [PostgreSQL 17.1](https://www.postgresql.org/docs/17/index.html)\n  (production) / SQLite (development)\n\n## File Structure\n\n```\navailabili.tf/               root\n├── availabili.tf/           frontend (Vue.js)\n├── backend-flask/           backend/software layer (Python)\n├── nginx/                   reverse proxy\n├── docker-compose.prod.yml  production environment\n├── docker-compose.yml       development environment\n└── README.md                this file\n```\n\n## Setup (production, Postgres)\n\nBuild the frontend app, assuming Node.js is installed:\n\n```sh\ncd availabili.tf\nnpm install\nnpm run build\ncd ..\n```\n\nBuild the rest of the containers:\n\n```sh\ndocker compose -f docker-compose.prod.yml build\ndocker compose -f docker-compose.prod.yml up db backend\n```\n\nPerform initial database migration. This is for automatically setting up the\ndatabase schema for the first time:\n\n```sh\ndocker exec -it backend-production bash\nflask db upgrade\nexit\n```\n\nBring up the rest of the containers:\n\n```sh\ndocker compose -f docker-compose.prod.yml up\n```\n\nThe app will run at port 8000 and the database will be available at port 5432.\n\n## Setup (development, SQLite3)\n\nBuild the frontend app:\n\n```sh\ncd availabili.tf\nnpm install\nnpm run build\n```\n\nBuild the rest of the containers and perform initial database migration:\n\n```sh\ndocker compose build\ndocker compose up\nDATABASE_URI=sqlite:///db.sqlite3 flask db upgrade\n```\n\nThe app will run at port 8000.\n\n## OpenAPI\n\nThe backend will automatically serve its OpenAPI-compliant spec at\n`/apidoc/openapi.json` which can also be viewed at `/apidoc/redoc` or\n`/apidoc/swagger` or `/apidoc/scalar`.\n\nTo regenerate the frontend client during development:\n\n```sh\nnpm run openapi-generate\n```\n\n## CS 333 Project\n\nTest coverage is 81% with several unit tests and 5 integration tests. Tests are\nlocated in `backend-flask/tests` GitHub Actions are used to run the tests on\nevery push to the master branch. If the tests fail or the test coverage drops\nbelow 75%, the workflow will fail. If the workflow succeeds, a docker will be\nbuilt and pushed into the GitHub container registry. The docker image will be\ntagged with the latest tag. A Komodo deployment will automatically be triggered\nto deploy the new image to the environment.\n\n## Screenshots\n\n### Home\n\n![Homepage](./docs/homepage.png)\n\n### Schedule\n\n![Schedule](./docs/schedule-page.png)\n\n### Team\n\n![Team](./docs/teampage.png)\n\n### Team Settings\n\n![Team Settings](./docs/settings-page.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanoidsandvichdispenser%2Favailabili.tf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhumanoidsandvichdispenser%2Favailabili.tf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanoidsandvichdispenser%2Favailabili.tf/lists"}