{"id":23867170,"url":"https://github.com/kirankumar-matham96/python-flask-rest-api","last_synced_at":"2026-04-12T09:45:44.434Z","repository":{"id":270210590,"uuid":"909646036","full_name":"kirankumar-Matham96/Python-Flask-REST-API","owner":"kirankumar-Matham96","description":"This repository contains a Flask API application connected to a PostgreSQL database, dockerized using Docker Compose. It provides CRUD operations for managing user data.","archived":false,"fork":false,"pushed_at":"2024-12-29T11:23:19.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-29T12:23:16.502Z","etag":null,"topics":["crud","docker","docker-compose","flask","python3","rest-api"],"latest_commit_sha":null,"homepage":"","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/kirankumar-Matham96.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":"2024-12-29T11:12:30.000Z","updated_at":"2024-12-29T11:24:53.000Z","dependencies_parsed_at":"2024-12-29T12:23:25.966Z","dependency_job_id":"188f41cb-c49f-42f1-a786-69f616c7a0be","html_url":"https://github.com/kirankumar-Matham96/Python-Flask-REST-API","commit_stats":null,"previous_names":["kirankumar-matham96/python-flask-rest-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirankumar-Matham96%2FPython-Flask-REST-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirankumar-Matham96%2FPython-Flask-REST-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirankumar-Matham96%2FPython-Flask-REST-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirankumar-Matham96%2FPython-Flask-REST-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kirankumar-Matham96","download_url":"https://codeload.github.com/kirankumar-Matham96/Python-Flask-REST-API/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240198413,"owners_count":19763745,"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":["crud","docker","docker-compose","flask","python3","rest-api"],"created_at":"2025-01-03T10:16:30.075Z","updated_at":"2026-04-12T09:45:39.413Z","avatar_url":"https://github.com/kirankumar-Matham96.png","language":"Python","readme":"# Python Flask Rest API\n\nThis repository contains a Flask API application connected to a PostgreSQL database, dockerized using Docker Compose. It provides CRUD operations for managing user data.\n\n---\n\n## Features\n\n- Create, Read, Update, and Delete (CRUD) operations for user management.\n- PostgreSQL database for persistent storage.\n- Dockerized application for easy deployment.\n- Environment variable support for database configuration.\n- CORS enabled for cross-origin requests.\n\n---\n\n## Prerequisites\n\nEnsure the following software is installed:\n\n1. [Docker](https://docs.docker.com/get-docker/)\n2. [Docker Compose](https://docs.docker.com/compose/install/)\n\n---\n\n## Project Structure\n\n```\n.\n├── backend\n│   ├── app.py\n│   ├── requirements.txt\n│   └── flask.dockerfile\n├── docker-compose.yml\n└── README.md\n```\n\n---\n\n## Setup Instructions\n\n### 1. Clone the repository\n\n```\ngit clone \u003crepository-url\u003e\ncd \u003crepository-folder\u003e\n```\n\n### 2. Start the application\n\n```\ndocker-compose up --build\n```\n\nThis command builds and starts the Flask API and PostgreSQL database containers.\n\n### 3. Verify running services\n\n```\ndocker ps\n```\n\nEnsure both `flaskapp` and `db` containers are running.\n\n---\n\n## API Endpoints\n\n### Base URL\n\n```\nhttp://localhost:4000/api/flask\n```\n\n### Test Route\n\n**GET** `/test`\n\n- Response: `{ \"message\": \"The server is running\" }`\n\n### Create User\n\n**POST** `/users`\n\n- Request Body:\n\n```\n{\n  \"name\": \"John Doe\",\n  \"email\": \"johndoe@example.com\"\n}\n```\n\n- Response:\n\n```\n{\n  \"id\": 1,\n  \"name\": \"John Doe\",\n  \"email\": \"johndoe@example.com\"\n}\n```\n\n### Get All Users\n\n**GET** `/users`\n\n- Response:\n\n```\n[\n  {\n    \"id\": 1,\n    \"name\": \"John Doe\",\n    \"email\": \"johndoe@example.com\"\n  }\n]\n```\n\n### Get User by ID\n\n**GET** `/users/\u003cid\u003e`\n\n- Response:\n\n```\n{\n  \"user\": {\n    \"id\": 1,\n    \"name\": \"John Doe\",\n    \"email\": \"johndoe@example.com\"\n  }\n}\n```\n\n### Update User\n\n**PUT** `/users/\u003cid\u003e`\n\n- Request Body:\n\n```\n{\n  \"name\": \"John Updated\",\n  \"email\": \"johnupdated@example.com\"\n}\n```\n\n- Response:\n\n```\n{\n  \"message\": \"user updated\"\n}\n```\n\n### Delete User\n\n**DELETE** `/users/\u003cid\u003e`\n\n- Response:\n\n```\n{\n  \"message\": \"user deleted\"\n}\n```\n\n---\n\n## Environment Variables\n\n**Defined in `docker-compose.yml`:**\n\n- `DATABASE_URL`: PostgreSQL connection string for Flask.\n- `POSTGRES_USER`: Database username.\n- `POSTGRES_PASSWORD`: Database password.\n- `POSTGRES_DB`: Database name.\n\n---\n\n## Database Persistence\n\nData is persisted using a Docker volume:\n\n```\nvolumes:\n  pgdata:\n```\n\nThis ensures data is not lost when the container restarts.\n\n---\n\n## Stopping the Application\n\nTo stop the containers, run:\n\n```\ndocker-compose down\n```\n\nTo remove all volumes (including database data):\n\n```\ndocker-compose down -v\n```\n\n---\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirankumar-matham96%2Fpython-flask-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkirankumar-matham96%2Fpython-flask-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirankumar-matham96%2Fpython-flask-rest-api/lists"}