Skip to content

Latest commit

 

History

History
76 lines (63 loc) · 3.11 KB

README.md

File metadata and controls

76 lines (63 loc) · 3.11 KB

File-Sharing-Application 🗂️

File-Sharing-Application is a modern and efficient file-sharing solution built on the MERN (MongoDB, Express.js, React.js, Node.js) stack. This project allows users to effortlessly upload files and generate unique links for easy sharing.

Preview ✨

Screenshot 2024-01-01 222137

Features 🪄

  • Seamless File Uploads: Intuitive user interface for hassle-free easy file uploads.
  • Unique Link Generation: Each uploaded file is assigned a unique link for easy sharing.
  • MERN Stack: Utilizes MongoDB for secure storage, Express.js and Node.js for the backend, and React.js for the frontend.
  • User-Friendly Interface: A sleek and responsive design ensures a smooth user experience.

Getting Started

To run this project locally, follow these steps:

  1. Clone the Repository:
    git clone https://github.com/sheelganvir/File-Sharing-Application.git
    cd File-Sharing-Application
  2. Install Dependencies:
    npm install
  3. Set Up MongoDB: Create a MongoDB database and configure the connection string in the .env file.
  4. Run the Application:
    npm start
    
  5. Open in Browser: Open your browser and go to http://localhost:8000 to access the File-Sharing-Application application.

Usage

  1. Upload Files: Click the "Upload" button to select and upload files.

  2. Generate Shareable Link: Each uploaded file will have a unique link that can be shared with others.

How to Contribute 🚀

  1. Fork this repository.
  2. Clone the forked repository.
    git clone https://github.com/sheelganvir/File-Sharing-Application
  3. Navigate to the project directory.
    cd File-Sharing-Application
  4. Create a new folder with your project name inside File-Sharing-Application and add your project files (e.g., index.html, style.css, script.js) inside that folder.
  5. Add a README file in your project folder that consists of descriptions/screenshots about your project.
  6. Create a new branch.
    git checkout -b <your_branch_name>
  7. Add and commit your changes.
    git add .
    git commit -m "<your_commit_message>"
  8. Push your local branch to the remote repository.
    git push -u origin <your_branch_name>
  9. Create a Pull Request! Congratulations! You've made your contribution to the File-Sharing-Application project.

Project Maintainer


Sheel Ganvir

Feel free to reach out to the maintainer for any questions or concerns.

License

This project is licensed under the MIT License.

Happy Coding! ✨