{"id":22413149,"url":"https://github.com/zodddev/fastapi-template","last_synced_at":"2025-03-27T03:24:52.474Z","repository":{"id":101215055,"uuid":"433821232","full_name":"zoddDev/fastapi-template","owner":"zoddDev","description":null,"archived":false,"fork":false,"pushed_at":"2021-12-10T13:04:09.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-01T08:47:57.240Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/zoddDev.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":"2021-12-01T12:38:38.000Z","updated_at":"2023-01-09T14:31:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"2ed7ea1c-2454-481f-a1b9-62b9dc9eabb8","html_url":"https://github.com/zoddDev/fastapi-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoddDev%2Ffastapi-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoddDev%2Ffastapi-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoddDev%2Ffastapi-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoddDev%2Ffastapi-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zoddDev","download_url":"https://codeload.github.com/zoddDev/fastapi-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245774723,"owners_count":20670000,"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":[],"created_at":"2024-12-05T14:12:00.946Z","updated_at":"2025-03-27T03:24:52.450Z","avatar_url":"https://github.com/zoddDev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tecnologías usadas\n\n## Backend\n\n(Directorio `backend`)\n\n#### Framework\n\nSe ha utilizado el framework FastAPI (Python 3) para la API REST.\n\n#### Base de datos\n\nEn cuanto a la base de datos, se ha utilizado MongoDB (credenciales disponibles en `./backend/config/db.py`)\n\n## Frontend\n\n(Directorio `frontend`)\n\n#### Cliente REST\n\nSe han utilizado HTML5 y el framework Vue.js (JavaScript) para el cliente REST (directorio `./frontend/rest_client`).\n\n#### Cliente AJAX\n\nSe han utilizado HTML5 y AJAX para el cliente AJAX (directorio `./frontend/ajax_client`).\n\n#### Cliente Textual\n\nSe han utilizado python3 para el cliente Textual (directorio `./frontend/text_client`).\n\n\n# Manual de usuario\n\n## Instalación del backend\n\n- Descargar e instalar [python3](https://www.python.org/downloads/) .\n\n- Ejecutar el fichero `./backend/install.bat`\n  - Alternativamente ejecutar:\n    ```\n    pip3 install -r ./backend/requirements.txt\n    ```\n\n## Ejecución\n\n#### API REST\n\n- Ejecutar el fichero `./backend/run.bat`\n  - Alternativamente y estando dentro del directorio `./backend` ejecutar:\n    ```\n    uvicorn run:app --reload\n    ```\n  - El servidor se abrirá en `http://localhost:8000`\n\n#### Cliente REST\n\n- Abrir el fichero `./frontend/rest_client/index.html` en un navegador de preferencia (p. ej. [Firefox](https://www.mozilla.org/es-ES/firefox/new/)).\n\n#### Cliente AJAX\n\n- Abrir el fichero `./frontend/ajax_client/index.html` en un navegador de preferencia (p. ej. [Firefox](https://www.mozilla.org/es-ES/firefox/new/)).\n\n#### Cliente Textual\n\n- Ejecutar el fichero `./frontend/text_client/main.py` utilizando el comando `python3 ./frontend/text_client/main.py`.\n\n## Documentación\n\nLa documentación de la API REST viene definida en la misma API haciendo uso de OpenAPI, concretamente en `http://localhost:8000/docs` .\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzodddev%2Ffastapi-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzodddev%2Ffastapi-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzodddev%2Ffastapi-template/lists"}