Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Salmandabbakuti committed Jun 9, 2024
1 parent 7a940c9 commit 80760b6
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Superfluid Dashboard

The Superfluid Dashboard provides a visual and interactive platform to manage and monitor Superfluid money streams. Users can:

View detailed information about all streams.Search and filter streams based on various criteria.Access their own streams for easy management.

### Whats next for Superfluid Dashboard

Stream Management: Implement create, update, and delete functionalities for user streams from the dashboard.

SuperToken Balances: Display user SuperToken balances on the dashboard.

Wrapping/Unwrapping SuperTokens: Add functionality for wrapping and unwrapping SuperTokens.

Notification System: Develop an in-house notification system using the Push Protocol to send updates to receivers about their stream statuses.

### Deployed Resources:

- [App](https://superfluid-dashboard-wavehack.vercel.app/)
- [Subgraph](https://api.studio.thegraph.com/proxy/15343/superfluid-dashboard-sepolia/version/latest/)

## Getting Started

```bash
npm install

npm run dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### Demo

![Screen1](https://github.com/Salmandabbakuti/superfluid-dashboard-wavehack/assets/29351207/72c8cc0d-a121-4fe2-b491-5b0891b99781)

![Screen2](https://github.com/Salmandabbakuti/superfluid-dashboard-wavehack/assets/29351207/ea0adba4-b77a-4d7b-ae6d-742a224c87a1)

## Built With

- [Next.js](https://nextjs.org/)
- [Ant Design](https://ant.design/)
- [Superfluid](https://www.superfluid.finance/)
- [ethers.js](https://docs.ethers.io/v5/)
- [The Graph](https://thegraph.com/)

## Safety

This is experimental software and evolving quickly. It is not ready for production use. Use at your own risk.

Superfluid Asset Streaming App is a proof of concept and is not ready for production use. It is not audited and has not been tested for security. Use at your own risk. I do not give any warranties and will not be liable for any loss incurred through any use of this codebase.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

0 comments on commit 80760b6

Please sign in to comment.