https://github.com/othastudio/tbx-file-uploader
A simple rest api to upload files and return a file to host assets as cdn for tastybox.
https://github.com/othastudio/tbx-file-uploader
javascript nodejs
Last synced: about 1 month ago
JSON representation
A simple rest api to upload files and return a file to host assets as cdn for tastybox.
- Host: GitHub
- URL: https://github.com/othastudio/tbx-file-uploader
- Owner: othastudio
- Created: 2023-05-28T16:50:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-29T11:30:57.000Z (about 3 years ago)
- Last Synced: 2025-09-04T02:44:04.036Z (10 months ago)
- Topics: javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 1.43 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](LICENSE)
## About
This API provides a seamless solution for uploading and retrieving images within your projects. Developed using Node.js, Express, and Multer, it simplifies the process of handling image uploads and enables effortless integration into both monolithic and microservices architectures.
## Key Features
- **Effortless Image Upload**: Upload images in various formats (JPEG, PNG, GIF) with ease using Multer.
- **Automatic Link Generation**: Each uploaded image is assigned a unique link for easy retrieval across platforms.
- **Flexible Integration**: Integrate the API into your monolithic or microservices projects seamlessly.
- **CDN-like Functionality**: Leverage the API as a Content Delivery Network (CDN) or cloud service for efficient image delivery.
- **Scalable and Robust**: Built with Node.js and Express, the API is designed to handle high volumes of uploads and retrieval requests.
- **Developer-Friendly**: Well-documented API with a user-friendly interface for quick integration into your projects.
## Installation
1. Clone the repository: `https://github.com/othastudio/tastybox-file-uploader.git`
2. Navigate to the project directory: `cd tastybox-file-uploader.git`
3. Install the dependencies: `npm install`
## Usage
1. Start the API server: `npm run start` or `npm run dev`
2. Make HTTP POST requests to the `/upload` endpoint with your image files.
3. Retrieve the generated image links from the API response. `http://localhost:8000/images/image-218387123.png` as json response.
4. Store the image links in your database or use them directly in your applications.
## Contributing
Thank you for considering contributing to the Tastybox The Contributors can be found below:
[Othmane N. | Senior Full-stack developer Developer ](https://otha.studio)
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For any questions or inquiries, please reach out to us at [hello@otha.studio](mailto:hello@otha.studio).
---