CLI Bluetooth File Sharing with Node.js and Socket.io

Welcome to the CLI Bluetooth project for Hacktoberfest 2023! Join us in contributing to open source and make CLI-based file sharing easier and more efficient using Node.js and Socket.io.

What is Hacktoberfest?

Hacktoberfest is an annual event that encourages participation in the open source community. By completing this challenge, you can earn limited edition rewards and be a part of the ever-growing open source community.📢Register for Hacktoberfest here and make four pull requests (PRs) between October 1st-31st to get awesome rewards! 🔥

STAR⭐ The Repository OPEN FIRST Pull Request & Get it Merged! 🎉 🗣

Project Overview

Our project aims to create a CLI-based file sharing solution using Node.js and Socket.io. The idea is to establish a connection between two devices using Socket.io and enable users to share files seamlessly through this connection. Let's learn and contribute to open source by enhancing this project!

Getting Started

To get started with this project, follow these steps:

1. Clone the Repository:

   git clone https://github.com/your-username/CLI-Bluetooth.git
   

2. Install Dependencies: Navigate to the project directory and install the required dependencies:

   cd CLI-Bluetooth
   npm install
   

3. Start the Server: Start the server by running the following command:

   node server.js
   

4. Run the Client: In a separate terminal, run the client by providing the path to the file(s) you want to share:

   node client.js /path/to/your/file1 /path/to/your/file2
   

You can specify one or more file paths to share multiple files simultaneously.

Usage Instructions

To use the CLI menu, follow these simple steps:

1. Installation: Make sure you have Node.js installed on your system.

2. Clone the Repository: Clone this repository to your local machine.

   git clone https://github.com/your-username/your-repo.git

3. Navigate to the Project Directory: Change your working directory to the project folder.

   cd your-repo

4. Install Dependencies: Install the necessary dependencies using npm.

   npm install

5. Run the CLI Menu: Start the CLI menu by running the following command:

   node CLI_MENU.mjs

6. Interact with the Menu: The CLI menu will be displayed with two options:

   • "Send file": Select this option to send a file. You will be prompted to input enter your name.
   • "Exit": Select this option to exit the CLI menu.

7. File Sending (Simulated): If you choose to send a file, the program will simulate sending the file.

8. Enter Your Name: When prompted, enter your name. The program will simulate storing your name.

9. Exiting the Menu: To exit the menu, select the "Exit" option.

That's it! You can now interact with the CLI menu and explore its functionality.

Feel free to adapt these instructions to fit your specific project and CLI menu implementation.

Current Progress

As of now, we have implemented the functionality to store files using server.js. However, there is more work to be done to make this project fully functional and user-friendly.

What We Need

We are looking for contributors to help us achieve the following goals:

1. Connect Multiple Users in the CLI: We need to enhance the project to support multiple users simultaneously connecting and sharing files through the CLI.

2. Deployment: Deploy our project so that it can be easily accessed and used by a wider audience.

How to Contribute

1. Fork this repository.

2. Clone your forked repository to your local machine:

   git clone https://github.com/your-username/CLI-Bluetooth.git

3. Create a new branch for your contribution:

   git checkout -b feature/your-feature-name

4. Make your desired changes, commit them, and push to your forked repository:

   git add .
   git commit -m "Added feature/updated feature"
   git push origin feature/your-feature-name

5. Open a Pull Request (PR) to this repository.

6. Our maintainers will review your PR and, if it meets the guidelines, merge it into the main project.

Our Valuable Contributors

A big thank you to our contributors who help make this project a success! Add your name here by getting your PR merged.

Let's work together to make this CLI Bluetooth File Sharing project even better! 🚀