# boosthub

**Repository Path**: gaowanlu/boosthub

## Basic Information

- **Project Name**: boosthub
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-18
- **Last Updated**: 2021-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


<div align="center">  

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

</div>  

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <h2 align="center">Boosthub</h2>

  <p align="center">
    Linux applications for lightweight file storage repositories and file transfer tools .
    <br />
    <a href="https://github.com/gaowanlu/boosthub"><strong>DOC »</strong></a>
    <br />
    <br />
  </p>
</div> 





## Introduction  
Using Boosthub you can store your file repository on the server side, and you can operate the repository on the client side.    

Boosthub is an extremely simple application that doesn't require other Linux applications to rely on . 
 


## Quick Start 
###  Ⅰ.Prepare  
```  
$ sudo apt update 
$ sudo apt install g++ gcc make cmake git 
$ sudo apt install glibc-doc manpages-posix-dev 
``` 

### Ⅱ.Get Boosthub
```shell 
$ cd ./boosthub 
$ cmake . 
$ make 
$ make install 
```
```code 
...
[100%] Built target boosthub
Install the project...
-- Install configuration: ""
-- Installing: /usr/bin/boosthub
```
### Ⅲ.Use Boosthub ()
```
$ boosthub -h 
Disclaimer: no client can use it at present. 
It can only be connected through socket. Developers are crazy about adding this function.
``` 




## Boosthub shell  
### `>> ls`  
`View the file and directory information under the location`  

```shell
>> ls
```
```shell
Now Path: /     This Path Inner Sum: 26 
Fd: 83406 Name: . Type:d 
Fd: 83406 Name: .. Type:d 
Fd: 83460 Name: hub Type:d 
Fd: 83461 Name: safe Type:d 
Fd: 83462 Name: boosthub Type:d 
```  

### `>> cd [Folder path]` 
`Switch the current path` 

```shell  
>> cd /var

Now Path: /var  

>> cd ./www

Now Path: /var/www  

>> ls

Now Path: /var/www     This Path Inner Sum: 3 
Fd              	Name            	Type            
762671          	.               	d               
762671          	..              	d               
762672          	html            	d               

>>cd ./html

Now Path: /var/www/html  

>> ls

Now Path: /var/www/html     This Path Inner Sum: 2 

Fd              	Name            	Type            
762672          	.               	d               
762672          	..              	d               
>>
``` 

### `>> pwd` 
`View the path at this time`  
```shell 
>> cd /var/www
Now Path: /var/www  
>> cd ../
Now Path: /var  
>> pwd
Now Path: /var 
``` 

### `>> get [File path]` 
`Gets the byte stream of the specified file` 
```shell 
>> ls
Now Path: /mnt/c/slago/build/static/js     This Path Inner Sum: 3 

Fd              	Name            	Type            
1339378         	.               	d               
1339378         	..              	d               
1339413         	hello.js	        f               

>> get ./hello.js  

console.log("Hello Boosthub"); 
```

## Why Boosthub? 
### `Why not use FTP?` 


》Of course, you can use the FTP tool, which is just a small personal project built for the fun of coding. It has great shortcomings, but I also want to use my own ideas to make my own satisfactory tools.  
》So, we just think of it as an interesting little toy.
 
### `Network protocol `


》Custom communication protocols over TCP/IP. Custom communication protocols on top of TCP/IP, showcasing does not guarantee your data security, but will certainly do its best.

### `Easy to deploy` 

》Users without experience in program development and shell commands can also quickly deploy and run on the server and operate on their file repositories with remote clients.

### `Just to be clear`  

》It's more like a useful, useless little toy that can also be used when needed.

---

## The project structure  

    src (Source code)
    ├── entity (Entity object class)
    ├── file (File related operations)
    ├── input (Processing user input)
    ├── log (Logging tools)
    ├── tool (Tool inheritance encapsulation) 
    ├── net (Network control layer)  
    ├── protocol (Communication protocol)  
    └── main.cpp 

---

## Developers  

This project is being maintained by only one person, if you can give suggestions or submit your code to make the project better. I would appreciate it.   



## Contact us for suggestions  
Email heizuboriyo@gmail.com  
It is developed and maintained in  `Guilin University of Electronic Technology`, China  



## Versions  

|  version   |  date  | changed content |  
|  ----  | ----  |----|  
| [v0.0.1]( )  | 2021/11/26 | Network communication, directory reading, log tools, etc |  



<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/gaowanlu/boosthub.svg?style=for-the-badge
[contributors-url]: https://github.com/gaowanlu/boosthub/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gaowanlu/boosthub.svg?style=for-the-badge
[forks-url]: https://github.com/gaowanlu/boosthub/network/members
[stars-shield]: https://img.shields.io/github/stars/gaowanlu/boosthub.svg?style=for-the-badge
[stars-url]: https://github.com/gaowanlu/boosthub/stargazers
[issues-shield]: https://img.shields.io/github/issues/gaowanlu/boosthub.svg?style=for-the-badge
[issues-url]: https://github.com/gaowanlu/boosthub/issues
[license-shield]: https://img.shields.io/github/license/gaowanlu/boosthub.svg?style=for-the-badge
[license-url]: https://github.com/gaowanlu/boosthub/blob/master/LICENSE.txt