{"id":21214173,"url":"https://github.com/finalsa/base-fastapi-api","last_synced_at":"2026-05-22T05:20:08.706Z","repository":{"id":105901852,"uuid":"380102855","full_name":"finalsa/base-fastapi-api","owner":"finalsa","description":"This is the base for the main projects made with fasta-I","archived":false,"fork":false,"pushed_at":"2024-07-19T04:31:45.000Z","size":41,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-21T16:23:00.372Z","etag":null,"topics":["fastapi"],"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/finalsa.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-25T02:29:21.000Z","updated_at":"2024-07-19T04:31:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"64031079-515f-4605-be46-2b1d4b0d4f60","html_url":"https://github.com/finalsa/base-fastapi-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finalsa%2Fbase-fastapi-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finalsa%2Fbase-fastapi-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finalsa%2Fbase-fastapi-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finalsa%2Fbase-fastapi-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/finalsa","download_url":"https://codeload.github.com/finalsa/base-fastapi-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243663581,"owners_count":20327306,"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":["fastapi"],"created_at":"2024-11-20T21:26:28.833Z","updated_at":"2026-05-22T05:20:08.660Z","avatar_url":"https://github.com/finalsa.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Base-fastapi-API\n\nThe api arquitecture is based on the good practices for Fast-API by @tialongo, for more information check https://fastapi.tiangolo.com\n## API Reference\n\nAll the models should have the same acces methods, you should check \nhttp://localhost:8000/docs for testings all the methods\n\n#### Get all items\n\n```http\n  GET /items\n```\n\n| Parameter | Type     | Description                |\n| :-------- | :------- | :------------------------- |\n| `token` | `string` | **Required**. Your API key |\n\n#### Get item\n\n```http\n  GET /api/items/${id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of item to fetch |\n\n\n\n#### Post Item\n\n```http\n  POST /items/\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of item to fetch |\n\n\n\n#### Put Item\n\n```http\n  PUT /items/${id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of item to fetch |\n\n\n\n\n#### Delete Item\n\n```http\n  DELETE /items/${id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of item to fetch |\n\n\n\n## Run Locally\n\nClone the project\n\n```bash\n  git clone ${project_link}\n```\n\nGo to the project directory\n\n```bash\n  cd ${project_name}\n```\n\nCreate a virutal environment \n\n```bash\n  virutalenv venv\n```\n\nActivate the virutalenv\n\n```bash\n  . ./venv/bin/activate\n```\n\n\nInstall dependencies\n\n```bash\n  python3 -m pip install -r requirements.txt\n```\n\nUpdate the db\n\n```bash\n  alembic revision --autogenerate -m \"made some changes\"\n  alembic upgrade head \n```\n\nStart the server\n\n```bash\n  cd app\n  python3 main.py\n```\n\nStart the celery server\n\n```bash\n  cd app\n  celery -A celery_app worker -B -l info \n```\n\n  \n## Deployment\n\nTo deploy this project run\n\n```bash\n    ./install.sh\n```\n\n  \n## Documentation\n\n[Documentation](https://linktodocumentation)\n\n  \n## License\n\nThe project is licensed only for the use by the team.\n\n  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinalsa%2Fbase-fastapi-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinalsa%2Fbase-fastapi-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinalsa%2Fbase-fastapi-api/lists"}