The Fula library abstracts away the protocols and `libp2p` connection, and exposes APIs similar to MongoDB
for data persistence and S3 for file storage
### Built With
* [libp2p](https://libp2p.io/)
* [protocols](/protocols)
## Getting Started
Use Server with caution and know the risk's because we are at development stage and the identity and encryption is
not available, so you become public node that can accessed from anywhere.
### Installation
Install NPM package
```sh
npm install @functionland/fula --save
```
or using CDN
```html
```
## Usage
Start fula and use file storage of [fula-server](/apps/server)
```js
import {Fula, createClient} from '@functionland/fula'
// Create a fula client
const fulaClient = await createClient();
// ...
// connect to a fula server by its base58 string PeerId
await fulaClient.connect(serverId)
// send file and get cid
// selectedFile send file use StreamReader interface or AsyncItrable and get cid
// meta {name,type,lastModified,size}
const FileCid = await fulaClient.sendStreamFile(selectedFile,meta);
// recive meta data
const data = await fulaClient.receiveMeta(fileId);
// recive file using cid
const data = await fulaClient.receiveFile(FileCid);
let reader = new FileReader();
reader.readAsDataURL(data);
reader.onloadend = (e) => setContent(reader.result)
```
For using it With private network:
```js
import {Fula, createClient} from '@functionland/fula'
// key_file is file_input[0] (value of file input)
const privateKey = await key_file.arrayBuffer()
// Create a fula client
const fulaClient = await createClient({},privateKey);
// ...
// connect to a fula server by its base58 string PeerId
await fulaClient.connect(serverId)
// send file and get cid
// selectedFile send file use StreamReader interface or AsyncItrable and get cid
// meta {name,type,lastModified,size}
const FileCid = await fulaClient.sendStreamFile(selectedFile,meta);
// recive meta data
const data = await fulaClient.receiveMeta(fileId);
// recive file using cid
const data = await fulaClient.receiveFile(FileCid);
let reader = new FileReader();
reader.readAsDataURL(data);
reader.onloadend = (e) => setContent(reader.result)
```
_For more examples, please refer to the [Examples](/examples/react-cra)_
## Roadmap
- [X] Protocols
- [X] File
- [X] GraphQL
- [ ] AI
- [ ] Identity
- [ ] Encryption
See the [open issues](https://github.com/functionland/fula/issues) for a full list of proposed features (and known issues).
## 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