This is a simple image uploader API. It uses cloudinary as a storage for the images and saves the secure and unique image URL to mongoDB database.

• General Info
• Documentation
• Prerequisites
• Modules and Dependencies
• Setup
• Usage

A simple API built with expressjs, mongoDB and cloudinary to save, store and retrieve images.

Click this link to view a detailed documentation of this resource.

To run this API locally or following through the implementation, Node.js runtime environment is required, most preferably, the long term support (LTS) version and mongoDB also.

The node modules used for this API are

• Express
• Mongoose
• Cloudinary with their versions shown in the package.json file.

To run this project (i.e. locally), mongodb should be available on your machine or use mongodb Atlas

• Clone the repo:

git clone https://github.com/VictorChukwudi/image-uploader-task.git

• Open the folder and run the command to install the dependencies:

npm install

• Go Cloudinary to sign up or login to get your unique cloud_name, api_key and api_secret

• Create a .env file in the root and add code below to the file

dbURI= <mongodb_connection_string>
PORT= 2000
CLOUD_NAME=<cloudinary_cloud_name>
API_KEY=<cloudinary_api_key>
API_SECRET=<cloudinary_api_secret>

• Next, run the command below to start the server

npm run dev

The Image Uploader API has the routes(endpoints) available for the api usage:

• POST /upload : to upload an image.
• GET /get_image/id : to retrieve an immage using the image id.

The routes are appended to the base URL with is

• for local

http://localhost:2000

• for deployed

https://image-uploader-x4uk.onrender.com

To use the deployed version of the API, the base URL is https://image-uploader-x4uk.onrender.com (with the routes attached for any of the operations)