{"id":23511517,"url":"https://github.com/mohitkumarsahni/todo-api","last_synced_at":"2025-10-04T17:58:25.920Z","repository":{"id":239970803,"uuid":"581242250","full_name":"mohitkumarsahni/todo-api","owner":"mohitkumarsahni","description":"An API for creating and managing tasks.","archived":false,"fork":false,"pushed_at":"2023-01-08T23:55:42.000Z","size":44,"stargazers_count":4,"open_issues_count":0,"forks_count":13,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-19T03:09:22.288Z","etag":null,"topics":["api","example-project","maven-project","openapi3","springboot","springboot-rest-api","to-do-rest-api"],"latest_commit_sha":null,"homepage":"","language":"Java","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/mohitkumarsahni.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":"docs/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-22T16:43:37.000Z","updated_at":"2023-12-31T03:17:39.000Z","dependencies_parsed_at":"2024-05-16T05:52:47.796Z","dependency_job_id":null,"html_url":"https://github.com/mohitkumarsahni/todo-api","commit_stats":null,"previous_names":["mohitkumarsahni/todo-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mohitkumarsahni/todo-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohitkumarsahni%2Ftodo-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohitkumarsahni%2Ftodo-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohitkumarsahni%2Ftodo-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohitkumarsahni%2Ftodo-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mohitkumarsahni","download_url":"https://codeload.github.com/mohitkumarsahni/todo-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohitkumarsahni%2Ftodo-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278350987,"owners_count":25972676,"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","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["api","example-project","maven-project","openapi3","springboot","springboot-rest-api","to-do-rest-api"],"created_at":"2024-12-25T12:15:02.199Z","updated_at":"2025-10-04T17:58:25.844Z","avatar_url":"https://github.com/mohitkumarsahni.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## ToDo-API\nAn API for creating and managing tasks.\n\n### The API can perform following operations:\n\n- [x] Create a new task-list.\n- [x] Update a task-list.\n- [x] Fetch a task-list.\n- [x] Delete a task-list.\n- [x] Create a new task in a task-list.\n- [x] Update a task in a task-list.\n- [x] Fetch a task.\n- [x] Fetch all tasks in a task-list.\n- [x] Delete a task in a task-list.\n\nPlease see the [openapi contract](./docs/api-contract.yaml) for API endpoints and details.\n\n### Prerequisites\n\n#### Install Java 11\n- This application requires Java 11.\n- Please refer to the following link to download and install Java-11: [Java-11](https://www.oracle.com/in/java/technologies/javase/jdk11-archive-downloads.html)\n\n#### Install \u0026 Setup Database\n- This application requires MySQL 8.\n- Please refer to the following link to download and install MySQL-8: [MySQL-8](https://dev.mysql.com/doc/refman/8.0/en/installing.html)\n- To create database and user you can run following script: [db_setup.sql](./docs/database/db_setup.sql)\n\n### Running the application\n- Clone the repository.\n- Open the project in IntelliJ IDEA or any suitable IDE of your choice.\n- Add following environment variables in configurations:\n  - DB_HOST\n  - DB_NAME\n  - DB_PASSWORD\n  - DB_PORT\n  - DB_USERNAME\n- In IntelliJ IDEA, environment variables can be added from Run -\u003e Edit Configurations -\u003e Environment Variables\n- Run the project.\n\n### Build \u0026 run with Docker on Ubuntu\n- Install Docker from: [Docker](https://docs.docker.com/engine/install/ubuntu/)\n- In terminal switch to project directory.\n- Use following command: `docker build -t todo-api:1.0.0 .`\n- Above command will build the image.\n- Now run the following command:\n\n  `sudo docker run todo-api:1.0.0 -e \"DB_HOST=\u003cDB_HOST\u003e\" -e \"DB_PORT=\u003cDB_PORT\u003e\" -e \"DB_NAME=\u003cDB_NAME\u003e\" -e \"DB_USERNAME=\u003cDB_USERNAME\u003e\" -e \"DB_PASSWORD=\u003cDB_PASSWORD\u003e\" -p 8080:8080 -d `\n- Change the actual variable value in angle brackets.\n- It will spin up a container which can be accessed on `http://localhost:8080/`\n\n### Pending Work\n- Unit Testing\n- How to deploy with docker on ubuntu\n- How to deploy with Azure Web App Service\n- Authorization \u0026 Authentication","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohitkumarsahni%2Ftodo-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmohitkumarsahni%2Ftodo-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohitkumarsahni%2Ftodo-api/lists"}