{"id":15187167,"url":"https://github.com/ernestomedinam/hello-flask-alternative","last_synced_at":"2026-02-14T22:33:18.271Z","repository":{"id":254151872,"uuid":"804913685","full_name":"ernestomedinam/hello-flask-alternative","owner":"ernestomedinam","description":"flask + SQLAlchemy + swagger open REST api boilerplate","archived":false,"fork":false,"pushed_at":"2024-11-07T16:28:58.000Z","size":62,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-08T23:53:17.801Z","etag":null,"topics":["flask","psql","rest-api","swagger-ui"],"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/ernestomedinam.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-05-23T14:11:02.000Z","updated_at":"2024-11-07T16:29:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"75ea9da3-452b-45be-b8a9-f67fbbb59b93","html_url":"https://github.com/ernestomedinam/hello-flask-alternative","commit_stats":{"total_commits":12,"total_committers":1,"mean_commits":12.0,"dds":0.0,"last_synced_commit":"ae8e940c33cf241b479d22dfa04f29ce7dc1b612"},"previous_names":["ernestomedinam/hello-flask-alternative"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ernestomedinam/hello-flask-alternative","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ernestomedinam%2Fhello-flask-alternative","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ernestomedinam%2Fhello-flask-alternative/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ernestomedinam%2Fhello-flask-alternative/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ernestomedinam%2Fhello-flask-alternative/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ernestomedinam","download_url":"https://codeload.github.com/ernestomedinam/hello-flask-alternative/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ernestomedinam%2Fhello-flask-alternative/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29458783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T21:29:27.764Z","status":"ssl_error","status_checked_at":"2026-02-14T21:28:11.111Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["flask","psql","rest-api","swagger-ui"],"created_at":"2024-09-27T18:03:03.388Z","updated_at":"2026-02-14T22:33:18.252Z","avatar_url":"https://github.com/ernestomedinam.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hello flask + psql! 🤓\nlightly opinionated base template for flask api projects with use case examples for module based folder structure, OOP + SQLAlchemy (ORM) \u0026 self documented resource management under REST standards; built for 4GeeksAcademy community \u0026 open for all.\n\nrecently added docker support!\n\n## how to use 😎\n\n### 🐳 if docker: \n- make sure you have docker engine up \u0026 running\n- update `.env` file variables\n- follow docker instructions (pending), basically `$ docker compose build` \u0026 `$ docker compose up` on success\n\n### 🐍 no docker: \n- check python's version is greater or equal than the version in Pipfile\n- install project dependencies based on boilerplate's lock file with `$pipenv sync`\n- make sure you have a running psql instance \u0026 update variables in `.env` file\n- create a database on your psql instance named like the value for the corresponding variable in your `.env file`\n- run `$pipenv run upgrade` to bring your db up to date with your code\n- run `$pipenv run start-chicken-barn` to populate your barn with a couple of chickens\n- start dev server with `$pipenv run start`\n- check swagger api docs at `/swagger-iu`\n- test with `$pipenv run test`\n- code away\n\n\u003e need to add new code for a feature? first thing is to build tests based on desired behaviour of your objects when running this feature\n\n\u003e need to mock some objects for testing purposes based on dummy data? create a file for this purpose under the data folder on the current module\n\n\u003e need a new table on your database? update your classes that extend BaseModel and then run `$pipenv run migrate` to create a migration version file with required changes, and then `$pipenv run upgrade` to implement these changes to your database\n\n\u003e need to populate database table with dummy data? use mocking functions \u0026 data under the data folder, and add a file under the commands folder to create an app cli command to do so\n\n\u003e need a new endpoint? just add corresponding schema and resource files, and then make sure to register the resource on the current module's routes.py file\n\n## pending 🤪\n- update readme to add instructions to change app_name variable and folder name\n- update docs on how to use this docker implementation\n\n## notes 📝\n\u003e built with python 3.11.4\n\n\u003e note: this is not official 4GeeksAcademy content but I'd be really glad for it to be considered as such, so in spirit it kind of is 😅\n\n\u003e note: please, DO NOT use this boilerplate for your 4Geeks final project nor any of 4Geeks program projects as your TA's will reject them and I will be reprimanded 😐\n\nmade with ♥ by mentors @4GeeksAcademy.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fernestomedinam%2Fhello-flask-alternative","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fernestomedinam%2Fhello-flask-alternative","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fernestomedinam%2Fhello-flask-alternative/lists"}