https://github.com/ravi-prakash1907/caterapp
A Quick & Secured Data Sharing Application!
https://github.com/ravi-prakash1907/caterapp
application cater caterapp data data-sharing pip python
Last synced: 9 months ago
JSON representation
A Quick & Secured Data Sharing Application!
- Host: GitHub
- URL: https://github.com/ravi-prakash1907/caterapp
- Owner: ravi-prakash1907
- License: mit
- Created: 2021-05-22T03:09:58.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-13T17:17:51.000Z (about 3 years ago)
- Last Synced: 2023-09-22T20:39:46.944Z (over 2 years ago)
- Topics: application, cater, caterapp, data, data-sharing, pip, python
- Language: Python
- Homepage: https://ravi-prakash1907.github.io/CaterApp/
- Size: 1.09 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## **CaterApp - v1.1**
Installation
|
Usage
|
Contributing
[](https://github.com/ravi-prakash1907/cater)
[](./LICENSE)
[](https://ravi-prakash1907.github.io/CaterApp)
[](https://twitter.com/73MP0R4L)
[](https://github.com/ravi-prakash1907/CaterApp/releases)
## ✉️ Description
CaterApp is a cross platform, remotely data sharing tool created for sharing files in a quick and secured manner. It is aimed to integrate this tool with several more features including providing a User Interface.\
The _version 1.1_ of the CaterApp currently works with **command line interface** i.e. **CLI**.
### 💥 What's so exciting ?
CaterApp comes with a range of fantastic features for you:
1. Share **any** type of file, including large videos and compressed documents.
2. You can choose as much files as you want.
3. Keeps you updated with the file, i.e. being shared in real time.
4. Also, it displays the size of files (in bytes).
5. Automatically detects sender's IP.
6. Compresses multiple files before sending, if asked to do that.
6. Tells the **speed** at which the data got delivered and a lot more...
## 📌 Installation
This is a `python` application that relies on its [**cater**](https://ravi-prakash1907.github.io/cater/) module.
### ❓ Requirements
1. A device with any operating system having bash / zsh terminal or python shell(preferred Linux)
2. Python 3.2 or higher version
3. pip (latest recommended)
### ➡ Steps to Install
Installation can be done through CLI in just a few of the simple steps:
1. Either clone this repository or simply download the CaterApp-v1.1 here \([tar](https://github.com/ravi-prakash1907/CaterApp/archive/refs/tags/v1.1.tar.gz), [zip](https://github.com/ravi-prakash1907/CaterApp/archive/refs/tags/v1.1.zip)\)
2. Extract the compressed file (if you have cloned/downloaded) and navigate into **CaterApp** directory
3. Execute the `installer.sh` to install the application through following terminal command:
```sh
$ ./installer.sh
```
### Alternate Method
If you love the terminal than following method is indeed for you:
```sh
$ wget https://github.com/ravi-prakash1907/CaterApp/archive/refs/tags/v1.1.zip
$ unzip v1.1.zip
$ cd CaterApp-1.1
$ sh ./installer.sh
```
After successful installation, you should see something like this:
## 🤔 Usage
Once you have installed the application on your system, you can simply access CaterApp tool with a single command as follows:
```sh
$ cater-app
```
As an alternative, you can also follow the following:
```sh
$ cd ~/CaterApp/caterapp
$ python cater.py
```
_You can find a brief and perfect usage demo at [this Medium article](https://ravi-prakash1907.medium.com/caterapp-a-quick-file-sharing-tool-for-cli-a62756166153)._
#### Remember
1. Keep the file(s) in current working directory, that you want to share.
2. All your received files will appear in **received/** directory at the current location.
3. Both - the sender and receiver must be at the same network.
4. To know your current location before sharing / receiving the files, run:
```sh
$ pwd
```
To use the app **without installation**, please refer to [this link](./caterapp/).
## 🤝 Contributing
If you wish to contribute in this project, you can always **fork** this repo and generate a pull request with new changes. You may also raise issues, if any.
🌟 Happy sharing!!! 🌟
---
_Developed by [ravi](http://ravi-prakash1907.gitlab.io/) with ❤️ in 🐍_