Skip to content

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Your Image API - Inaugural Release v1.0.0

Welcome to the inaugural release of Your Image API! This version marks a significant step in crafting a robust image management solution for our interview.

Key Features

  • Seamless Image Upload:

    • Dedicated endpoint for effortless image uploads using multipart/form-data.
    • Each successful upload generates a secure URL.
  • User-Centric Image Retrieval:

    • New endpoint for retrieving images by secure URL.
    • Enhanced error handling for a smooth user experience.
  • Thoughtful Image Listing:

    • Initial endpoint provides a basic list of images with secure URLs and binary data.
  • Attention to Detail: Bug Fixes and Enhancements:

    • Resolved bugs with precision.
    • Improved error messages for better understanding and troubleshooting.

Next Steps and Collaboration

This initial release sets the foundation for future enhancements. I look forward to discussing potential improvements in our upcoming interview, iterating based on feedback and evolving needs.

Getting Started

For a detailed guide on leveraging Your Image API, refer to the API Documentation.

Live Link

Access the live Your Image API at [Live API Link].

System Requirements and Dependencies

Ensure your system meets the following requirements:

  • Node.js: Version 14.x or later.
  • npm: Version 6.x or later.
  • MongoDB: Version 4.x or later.

Environment Variables

Configure the following environment variables:

  • PORT: The port on which the API will run.
  • MONGODB_URI: The URI for your MongoDB database.

Project Setup

  1. Clone the Repository:

    git clone [[repository-url]](https://github.com/DamiAdeeso/Tobams-Task/)
    cd your-image-api
  2. Install Dependencies:

    npm install
  3. Configure Environment Variables: Create a .env file in the project root with the following content:

    PORT=your-chosen-port
    MONGODB_URI=your-mongodb-uri
    
  4. Start the API:

    npm start

    The API will be accessible at http://localhost:your-chosen-port.

Feel free to reach out with any questions. Looking forward to discussing the technical aspects in the next stage.


About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages