{"id":18029847,"url":"https://github.com/zeioth/idoven-technical-challenge","last_synced_at":"2025-04-04T21:13:54.616Z","repository":{"id":213591859,"uuid":"734467491","full_name":"Zeioth/idoven-technical-challenge","owner":"Zeioth","description":"Challenger: Adrian Lopez","archived":false,"fork":false,"pushed_at":"2024-01-01T11:21:03.000Z","size":53,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-27T13:47:14.886Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zeioth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-12-21T18:55:50.000Z","updated_at":"2023-12-22T08:10:00.000Z","dependencies_parsed_at":"2024-01-01T12:25:08.422Z","dependency_job_id":"9167ea81-b73b-4107-a7b5-03ab8e9a22ba","html_url":"https://github.com/Zeioth/idoven-technical-challenge","commit_stats":null,"previous_names":["zeioth/idoven-technical-challenge"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeioth%2Fidoven-technical-challenge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeioth%2Fidoven-technical-challenge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeioth%2Fidoven-technical-challenge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeioth%2Fidoven-technical-challenge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zeioth","download_url":"https://codeload.github.com/Zeioth/idoven-technical-challenge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249549,"owners_count":20908212,"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-10-30T09:11:40.853Z","updated_at":"2025-04-04T21:13:54.597Z","avatar_url":"https://github.com/Zeioth.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Introduction\nThis code has been generated from\n[these](https://github.com/idoven/backend-challenge/tree/main) requirements\nas part of the technical interview for the startup Idoven.\n\n![screenshot_2023-12-21_18-44-05_296796801](https://github.com/Zeioth/idoven-technical-challenge/assets/3357792/ca0ca91d-f3f3-4163-883d-ae9bf441070c)\n\n## How to use\nInstall the pre-requirements\n\n```\nsudo apt install docker virtualenv\n```\n\nCreate and enable a virtualenv and install the dependencies with\n\n```sh\ncd ~/\npython -m venv venv\nsource ~/venv/bin/activate\npip install -r requirements.txt\n```\n\nStart the database\n\n```sh\ndocker run -e POSTGRES_DB=idovendb -e POSTGRES_USER=apiuser -e POSTGRES_PASSWORD=apipassword -p 5432:5432 -d postgres\n```\n\nStart the FastAPI server\n```\ncd ./app\nuvicorn main:app --reload\n```\n\nOnce the FastAPI server is running you can run the tests\n\n```\ncd ./tests\nptw\n```\nOnce you end developing you can stop the virtualenv with\n```sh\ndeactivate\n```\n\n### Extra commands\nOptionally you can run the project in production mode with\n\n```\nAPP_ENV=production uvicorn main:app\n```\n\nOptionally you can connect to the database in interactive mode with\n```\ndocker ps\ndocker exec -it \u003cinstance-id\u003e psql -U apiuser -d idovendb\n```\n\n## Directory structure\n\n```\n* app\n  * model\n    - /schemas.py\n    - /models.py\n  * view\n    - /ecgs.py\n    - /users.py\n  * controller\n    - /db.py\n    - /users.py\n    - /ecgs.py\n* tests\n  - /test_ecgs_endpoints.py\n  - /test_users_endpoints.py\n```\n\n## Capture of requirements\n[See here](https://github.com/Zeioth/idoven-technical-challenge/blob/main/requirements.md)\n\n## Development roadmap\n\n* **Friday**: Capture of requirements\n* **Monday**: MVP\n* **Tuesday**: Missing features\n* **Wednesday**: Tests\n* **Thursday**: Bug fixes\n\n\n## Architectural decisions\n\n* This project uses the code conventions [PEP8](https://peps.python.org/pep-0008/).\n* This project uses the docstring conventions [Google's python style guide](https://google.github.io/styleguide/pyguide.html).\n* The database we use is PostgreSQL.\n* The ORM we use is alchemysql.\n* The migration tool we use is alembic.\n* The database is normalized to Boyce Codd's 3º normal form.\n* The database implements foreign key constraints to ensure data integrity.\n* Aditional endpoint 'delete-user' to be used by users with the 'admin' role.\n\n## Out of scope\n\n* Database backups.\n* Logging system.\n* Alert system like prometheus.\n* Persistent tokens. In case we plan using a load balancer for the users\nmicroservice in the future, this would be a good idea.\n* A logout endoint.\n* Using email or telephone as primary key for users would be desireable.\n* Before leaving staging, we must modify the tests to self-clean data.\n* According to the requirements, admins can create users.\n  But the requirements do not specify the fact a admin shouldn't\n  probably be able to create users with the role 'admin'.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeioth%2Fidoven-technical-challenge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeioth%2Fidoven-technical-challenge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeioth%2Fidoven-technical-challenge/lists"}