Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/silent-watcher/fileuploader

An Express js image uploader for your next project 🫡 Leave a star before you leave ⭐
https://github.com/silent-watcher/fileuploader

backend-projects ejs express-image-upload expressjs node

Last synced: about 1 month ago
JSON representation

An Express js image uploader for your next project 🫡 Leave a star before you leave ⭐

Awesome Lists containing this project

README

        

![FileUploader](public/img/banner.png)

# 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.

Awesome Made With Love
commitizen-friendly

[![Star this project](https://img.shields.io/badge/-⭐%20Star%20this%20project-yellow?style=for-the-badge)](https://github.com/Silent-Watcher/fileUploader)

## Table of Contents

- [demo](https://github.com/Silent-Watcher/fileUploader#demo)
- [Features](https://github.com/Silent-Watcher/fileUploader#features)
- [Prerequisites](https://github.com/Silent-Watcher/fileUploader#Prerequisites)
- [Installation](https://github.com/Silent-Watcher/fileUploader#Installation)
- [usage](https://github.com/Silent-Watcher/fileUploader#usage)
- [Contributing](https://github.com/Silent-Watcher/fileUploader#Contributing)
- [Contact](https://github.com/Silent-Watcher/fileUploader#Contact)
- [License](https://github.com/Silent-Watcher/fileUploader#License)

## Demo

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



[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/Silent-Watcher/fileUploader)

## 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:

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

2. Navigate to the project directory in your terminal.

```bash
cd fileUploader
```

3. Run `npm install` to install the necessary packages.

```bash
npm install
```

4. Run `npm run prepare` to install husky.

```bash
npm run prepare
```

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

```bash
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}.

```bash
npm run start
```

## Technologies

![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)
![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![Nodemon](https://img.shields.io/badge/NODEMON-%23323330.svg?style=for-the-badge&logo=nodemon&logoColor=%BBDEAD)
![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)

## 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: [email protected]

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

## License 🔐

[MIT](https://choosealicense.com/licenses/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.