FileUploader

FileUploader is a simple image uploader application that allows you to upload images and store them in MongoDB. Once the images are uploaded successfully, the app displays them.

Table of Contents

• demo
• Features
• Prerequisites
• Installation
• usage
• Contributing
• Contact
• License

Demo

Experience the power of the fileUploader by visiting the demo page.

Features

• Image Uploading: Easily upload images from your device.
• MongoDB Integration: Images are stored in MongoDB, ensuring data persistence.
• Responsive Design: The web application is designed to work seamlessly on various devices and screen sizes, ensuring a responsive and user-friendly experience.
• Image Display:View the uploaded images after they have been successfully stored in the database.
• User-Friendly Interface: The web interface is designed with a clean and intuitive layout, making it easy for users to understand and play the game.
• Open Source: The project is hosted on GitHub and is open source, allowing developers to explore the codebase, contribute to the project, or use it as a learning resource.

Prerequisites

In order to run this project, you will need to have the following installed on your computer:

• nodejs
• yarn | npm | pnpm
• A running instance of MongoDB for database storage.

Installation

To install the application, follow these steps:

1. Clone the repository to your local machine:

git clone https://github.com/Silent-Watcher/fileUploader

2. Navigate to the project directory in your terminal.

  cd fileUploader

3. Run npm install to install the necessary packages.

  npm install

4. Run npm run prepare to install husky.

  npm run prepare

5. Create a .env file in the project's root directory and configure the following variables:

  APP_ENV = value

checkout .env.example file for possible values

6. navigate to env.config.js file inside of config directory for important env variables. you have to define these variables before running the app

usage

To start the application, run npm run start . This will start the application on http://localhost:${env.port}.

npm run start

Technologies

Contributing 🤝🏾

Contributions to this project are welcome. If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.

Before contributing, please review the contribution guidelines.

Contact

For additional information or inquiries, you can reach out to the project maintainer:

• Name: Silent-Watcher
• Email: alitabatabaee20@mail.com

Feel free to contact the maintainer for any questions or feedback regarding the project.

License 🔐

MIT

This project is licensed under the MIT License. You are free to modify, distribute, and use the code for personal and commercial purposes. See the LICENSE file for details.

Sponsor ❤

If you like this project, please give it a star ⭐ and/or consider buying me a coffee(s). Every donation is appreciated.