{"id":14989742,"url":"https://github.com/pradumnasaraf/opensource-api","last_synced_at":"2025-09-10T15:33:41.384Z","repository":{"id":37794490,"uuid":"500415606","full_name":"Pradumnasaraf/OpenSource-API","owner":"Pradumnasaraf","description":"A free and public Open Source API.","archived":false,"fork":false,"pushed_at":"2024-01-26T16:03:29.000Z","size":328,"stargazers_count":29,"open_issues_count":0,"forks_count":17,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T20:51:12.166Z","etag":null,"topics":["api","chai","docker","express","javascript","mocha","mongodb","mongoose","nodejs"],"latest_commit_sha":null,"homepage":"https://opensourceapi.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pradumnasaraf.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["eddiejaoude"]}},"created_at":"2022-06-06T12:00:22.000Z","updated_at":"2025-01-12T15:30:53.000Z","dependencies_parsed_at":"2024-01-26T17:25:23.922Z","dependency_job_id":"6764f844-74b7-4b4d-91d2-4e988622d7a0","html_url":"https://github.com/Pradumnasaraf/OpenSource-API","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FOpenSource-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FOpenSource-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FOpenSource-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FOpenSource-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pradumnasaraf","download_url":"https://codeload.github.com/Pradumnasaraf/OpenSource-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501406,"owners_count":21114673,"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":["api","chai","docker","express","javascript","mocha","mongodb","mongoose","nodejs"],"created_at":"2024-09-24T14:18:51.186Z","updated_at":"2025-04-12T00:31:58.216Z","avatar_url":"https://github.com/Pradumnasaraf.png","language":"JavaScript","funding_links":["https://github.com/sponsors/eddiejaoude"],"categories":[],"sub_categories":[],"readme":"![OpenSource API banner](https://user-images.githubusercontent.com/51878265/212617054-61bc38e5-ea65-4594-a23c-f46de14b7fec.png)\n\n\u003cdiv align=\"center\"\u003e\n\n\u003ch3 \u003eAn Open Source, free, and public API.\u003ch3\u003e\n\n[![Publish Docker Image to DockerHub](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-dockerhub.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-dockerhub.yml) [![Publish Image to GitHub Container Registry](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-ghcr.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-ghcr.yml) [![Unit Tests + Lint](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/lint-testing.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/lint-testing.yml) [![Format](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/prettier.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/prettier.yml)\n\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n## 🛠️ Technlogies used\n\n|           Server           | Database |   Testing   | Deployment |\n| :------------------------: | :------: | :---------: | :--------: |\n| Node.js, Express, Mongoose | MongoDB  | Mocha, Chai |   Vercel   |\n\n## 📌 Endpoints\n\n| Endpoints         | Description                 | Method |\n| :---------------- | :-------------------------- | :----- |\n| `/`               | Home page.                  | GET    |\n| `/api/devtip`     | Returns a list of dev tips. | GET    |\n| `/api/devtip/:id` | Returns a single dev tip.   | GET    |\n| `/api/devtip`     | Creates a new dev tip.      | POST   |\n| `/api/devtip/:id` | Updates a dev tip.          | PATCH  |\n| `/api/devtip/:id` | Deletes a dev tip.          | DELETE |\n\n## 👨‍💻 Developing the API\n\nThis section includes how to test and develop API at your end. You can either run it in the cloud using **Gitpod** or run it inside a container using **docker** or choose to set up the complete environment locally.\n\n**GitPod**\n\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Pradumnasaraf/OpenSource-API)\n\n**Docker Compose**\n\nPrerequisites - Docker and Compose installed in your local system.\n\nYou can run below command and you can access the API at `localhost:9009`\n\n```bash\ndocker compose up\n```\n\n**Local setup**\n\nPrerequisites- Node.js installed and a Mongo server on your localhost.\n\nMake sure you have installed all the dependencies and you have a MongoDB server running on your local machine. Also, make sure are in the root directory of the project.\n\nStep 1: Copy `.env.example` to `.env`.\n\n```bash\nnpm run env\n```\n\nStep 2: Run the app in development mode.\n\n```bash\nnpm run dev\n```\n\n## 🛡️ License\n\n**OpenSource API** is licensed under the GPL-3.0 License - see the [LICENSE](/LICENSE) file for details.\n\n## 🤝 Support\n\nDon't forget to leave a star ⭐️.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradumnasaraf%2Fopensource-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpradumnasaraf%2Fopensource-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradumnasaraf%2Fopensource-api/lists"}