Skip to content
Projects

Pradumnasaraf/OpenSource-API has 32 GitHub stars and 17 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-17 14:55 UTC. Last push 2026-11-14.

How these counts are measured

Measured star growth

in 24h
0
in 7 days
Collecting history
in 15 days
Collecting history
in 1 month
Collecting history

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

About

A free and public Open Source API.

Developer Tools

README.md

Original

OpenSource API banner

An Open Source, free, and public API.

Publish Docker Image to DockerHub Publish Image to GitHub Container Registry Unit Tests + Lint Format


🛠️ Technlogies used

Server Database Testing Deployment
Node.js, Express, Mongoose MongoDB Mocha, Chai Vercel

📌 Endpoints

Endpoints Description Method
/ Home page. GET
/api/devtip Returns a list of dev tips. GET
/api/devtip/:id Returns a single dev tip. GET
/api/devtip Creates a new dev tip. POST
/api/devtip/:id Updates a dev tip. PATCH
/api/devtip/:id Deletes a dev tip. DELETE

👨‍💻 Developing the API

This section includes how to test and develop the API at your end. You can run it inside a container using docker or set up the complete environment locally.

Docker Compose

Prerequisites - Docker and Compose installed in your local system.

You can run below command and you can access the API at localhost:9009

docker compose up

Local setup

Prerequisites- Node.js installed and a Mongo server on your localhost.

Make 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.

Step 1: Copy .env.example to .env.

npm run env

Step 2: Run the app in development mode.

npm run dev

🛡️ License

OpenSource API is licensed under the GPL-3.0 License - see the LICENSE file for details.

🤝 Support

Don't forget to leave a star ⭐️.