server

Borg Server

Borg server turn your device to W3 node with configured IPFS server Which Borg client knows how to connect to it by its PeerID from anywhere.
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

Built With

• libp2p
• IPFS

(back to top)

Getting Started

Use Server with caution and know the risk's becuse we are at development stage and the identity and encription is not avalibale so you become public node that can accessed from anywhere.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• rush

  npm install -g @microsoft/rush

Installation

1. Clone the repo

   git clone https://github.com/functionland/borg.git

2. Install dependencies packages and build

   rush update
   rush build

(back to top)

Usage

Enter Server folder and start server

cd apps/server 
rushx start

For more examples, please refer to the Documentation

(back to top)

Roadmap

• [*] Protocols
  • [*] File
  • [] Data
  • [] AI
• [] Identity
• [] Encryption

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

See LICENSE for more information.

(back to top)