https://github.com/wnfs-wg/nest

A layer around the wnfs package that provides a FileSystem class, a root tree, mounts, transactions and some other essentials.
https://github.com/wnfs-wg/nest

Last synced: 1 day ago
JSON representation

A layer around the wnfs package that provides a FileSystem class, a root tree, mounts, transactions and some other essentials.

• Host: GitHub
• URL: https://github.com/wnfs-wg/nest
• Owner: wnfs-wg
• License: apache-2.0
• Created: 2023-12-07T13:18:47.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-06-01T03:42:05.000Z (6 months ago)
• Last Synced: 2024-08-08T22:15:18.743Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 575 KB
• Stars: 6
• Watchers: 7
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE-APACHE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# Nest 🪺

A layer around the `wnfs` package that provides a `FileSystem` class, a root tree, mounts, transactions and some other essentials.

_More info in the [package readme](https://github.com/wnfs-wg/nest/tree/main/packages/nest/README.md)._

## Packages

- [nest](https://github.com/wnfs-wg/nest/tree/main/packages/nest) - The primary `nest` package.

## Examples

- [`audio`](https://github.com/wnfs-wg/nest/tree/main/examples/audio) - Shows how to play audio from a file system using an `` element.

- [`demo`](https://github.com/wnfs-wg/nest/tree/main/examples/demo) - A simple demo of how the `nest` package is used.

- [`web3storage`](https://github.com/wnfs-wg/nest/tree/main/examples/web3storage) - An example app that shows how to store a WNFS on Web3Storage using the `nest` package.

### Checkout examples

You can use Codesandbox  and start hacking right away.

To clone it locally:

```bash

npx tiged wnfs-wg/nest/examples/demo demo

cd demo

pnpm install

pnpm dev

```

You can try any of the examples by replacing `demo` with the name of the example you want to try.

## Contributing

Read contributing guidelines [here](.github/CONTRIBUTING.md).

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/wnfs-wg/nest)

## License

This project is licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](./LICENSE-APACHE) or

  [http://www.apache.org/licenses/LICENSE-2.0][apache])

- MIT license ([LICENSE-MIT](./LICENSE-MIT) or

  [http://opensource.org/licenses/MIT][mit])

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally

submitted for inclusion in the work by you, as defined in the Apache-2.0

license, shall be dual licensed as above, without any additional terms or

conditions.

[apache]: https://www.apache.org/licenses/LICENSE-2.0

[mit]: http://opensource.org/licenses/MIT