Pradumnasaraf / OpenSource-API

A free and public Open Source API.

An Open Source, free, and public API.

🛠️ 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 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.

GitPod

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 ⭐️.