{"id":25454970,"url":"https://github.com/mauprogramador/ifms-dev-competition","last_synced_at":"2026-04-27T08:32:15.338Z","repository":{"id":272540413,"uuid":"916944269","full_name":"mauprogramador/ifms-dev-competition","owner":"mauprogramador","description":"RESTful API for managing the IFMS Development Competition","archived":false,"fork":false,"pushed_at":"2025-10-28T23:02:52.000Z","size":697,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-29T01:06:11.723Z","etag":null,"topics":["competition","development","fastapi","ifms","pydantic","pytest","python3","restful-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mauprogramador.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-15T03:45:42.000Z","updated_at":"2025-10-28T23:02:56.000Z","dependencies_parsed_at":"2025-05-16T16:11:16.127Z","dependency_job_id":"0a3b08aa-9da6-4e85-80ec-39d551feb1ac","html_url":"https://github.com/mauprogramador/ifms-dev-competition","commit_stats":null,"previous_names":["mauprogramador/ifms-dev-competition"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/mauprogramador/ifms-dev-competition","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauprogramador%2Fifms-dev-competition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauprogramador%2Fifms-dev-competition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauprogramador%2Fifms-dev-competition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauprogramador%2Fifms-dev-competition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mauprogramador","download_url":"https://codeload.github.com/mauprogramador/ifms-dev-competition/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauprogramador%2Fifms-dev-competition/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32329463,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["competition","development","fastapi","ifms","pydantic","pytest","python3","restful-api"],"created_at":"2025-02-18T00:55:50.997Z","updated_at":"2026-04-27T08:32:15.324Z","avatar_url":"https://github.com/mauprogramador.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IFMS Dev Competition\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./ifms.png\" width=\"150\" alt=\"IFMS\"\u003e\n\u003cp\u003e\n\u003cp align=\"center\"\u003e\n  \u003cem\u003eRESTful API for managing the IFMS Development Competition\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/mauprogramador/scopus-survey-api/actions/workflows/verification.yml\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/mauprogramador/scopus-survey-api/verification.yml?branch=master\u0026event=push\u0026logo=github\u0026label=Lint%26Test\u0026color=C5362B\" alt=\"Lint \u0026 Test\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mauprogramador/ifms-dev-competition/releases/latest\" target=\"_blank\" rel=\"external\" title=\"Latest Release\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/v/tag/mauprogramador/ifms-dev-competition?logo=github\u0026label=Release\u0026color=E9711C\" alt=\"Latest Release\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.python.org/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Python-v3.12-FBDA4E?logo=python\u0026logoColor=FFF\u0026labelColor=3776AB\" alt=\"Python3 version\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://fastapi.tiangolo.com/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/FastAPI-009688?logo=fastapi\u0026logoColor=FFF\" alt=\"FastAPI\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://docs.pydantic.dev/latest/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Pydantic-E92063?logo=pydantic\u0026logoColor=FFF\" alt=\"Pydantic\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opencv.org/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/OpenCV-5C3EE8?logo=opencv\u0026logoColor=FFF\" alt=\"OpenCV\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://playwright.dev/python/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Playwrigt-6BBB4B?logo=pypi\u0026logoColor=FFF\" alt=\"Playwright\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.python-httpx.org/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/HTTPX-3794F3?logo=pypi\u0026logoColor=FFF\" alt=\"HTTPX\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://python-poetry.org/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Poetry-60A5FA?logo=poetry\u0026logoColor=FFF\" alt=\"Poetry\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://docs.pytest.org/en/stable/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Pytest-0A9EDC?logo=pytest\u0026logoColor=FFF\" alt=\"Pytest\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://black.readthedocs.io/en/stable/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code style-black-000\" alt=\"Black\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://mypy.readthedocs.io/en/stable/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/mypy-checked-2A6DB2\" alt=\"MyPy\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pylint.readthedocs.io/en/stable/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/linting-pylint-yellowgreen\" alt=\"Pylint\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nFederal Institute of Mato Grosso do Sul \u0026nbsp;\u0026#8226;\u0026nbsp; [IFMS - Campus Três Lagoas](https://www.ifms.edu.br/campi/campus-tres-lagoas)\n\u003cbr/\u003e\nTechnology in Systems Analysis and Development \u0026nbsp;\u0026#8226;\u0026nbsp; [TADS](https://www.ifms.edu.br/campi/campus-tres-lagoas/cursos/graduacao/analise-e-desenvolvimento-de-sistemas)\n\n- RESTful API: \u003chttp://127.0.0.1:8000/v1/ifms-dev-competition/api\u003e\n- Swagger UI: \u003chttp://127.0.0.1:8000\u003e\n\n---\n\n## Overview\n\nThis **RESTful API** was developed to support the exchange of **HTML** and **CSS** files between teams in the **IFMS** programming competition.\n\n### Dynamics\n\n**First:** the pairs of each team will program independently and alternately, with each member in a language (**HTML** or **CSS**) one at a time.\n\n**Last:** the final, one finalist pair per team, the same project for all teams, the order and the way of programming will be decided by the game.\n\n### Teams Count\n\nBy default, **30** code directories will be generated for **First** Dynamic, and **10** code directories for **Last** Dynamic.\n\n### Files\n\nEach generated code directory will have two files: a **`HTML`** file type called **index.html** and a **`CSS`** file type called **`style.css`**.\n\n### Rate Limit\n\nThis application has a request rate limiting mechanism for **API tagged routes**, accepting up to **60 requests every 2 seconds**. Requests beyond this limit will be responded with an **HTTP 429 error**.\n\n---\n\n## Configuration\n\nYou can create an `.env` file to configure the following options:\n\n| **Parameter**   | **Description**                                          | **Default**   |\n| --------------- | -------------------------------------------------------- | ------------- |\n| `DATABASE_FILE` | Sets the database file (_.db_) absolute path             | `database.db` |\n| `HOST`          | Sets the host address to listen on                       | `127.0.0.1`   |\n| `PORT`          | Sets the server port on which the application will run   | `8000`        |\n| `RELOAD`        | Enable auto-reload on file changes for local development | `false`       |\n| `WORKERS`       | Sets multiple worker processes                           | `1`           |\n| `LOGGING_FILE`  | Enable saving logs to files                              | `false`       |\n| `DEBUG`         | Enable the debug mode and debug logs                     | `false`       |\n\n- The `RELOAD` and `WORKERS` options are **mutually exclusive**.\n\n- Setting the `HOST` to `0.0.0.0` makes the application externally available.\n\n- Set the `DATABASE_FILE` like `/home/user/project/repository/database.db`.\n\n- Set `WORKERS`, **maximum 4**, to start **multiple server processes**.\n\n- Database backup files will be saved inside the `/repository` directory.\n\n\u003e [!TIP]\n\u003e Take a look at the [`.env.example`](./.env.example) file.\n\n---\n\n## Run locally with Poetry or Pip\n\nYou will need [Python3.12](https://www.python.org/downloads/release/python-31211/) with [Pip](https://pip.pypa.io/en/stable/installation/) and [Venv](https://docs.python.org/3/library/venv.html) installed.\n\n```bash\n# Create new Venv\nmake venv\n\n# Activate Venv\nsource .venv/bin/activate\n\n# Install dependencies with Poetry [1]\n(.venv) make poetry-install\n\n# Install dependencies with Pip [2]\n(.venv) make pip-install\n\n# Run the App locally\n(.venv) make run\n```\n\n## Run with Docker\n\nYou will need [Docker](https://www.docker.com/) installed.\n\n```bash\n# Run the App in Docker Container\nmake docker\n```\n\n---\n\nFor questions or concerns please contact me at \u003csir.silvabmauricio@gmail.com\u003e.\n\n[License](./LICENSE)\n\u0026nbsp;\u0026#8226;\u0026nbsp;\n[Latest Release](https://github.com/mauprogramador/ifms-dev-competition/releases/latest)\n\u0026nbsp;\u0026#8226;\u0026nbsp;\n[Changelog](./CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmauprogramador%2Fifms-dev-competition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmauprogramador%2Fifms-dev-competition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmauprogramador%2Fifms-dev-competition/lists"}