https://github.com/degencast/s3

A explorer for the Ceramic network
https://github.com/degencast/s3

ceramic ceramic-network ipfs web3

Last synced: 3 days ago
JSON representation

A explorer for the Ceramic network

• Host: GitHub
• URL: https://github.com/degencast/s3
• Owner: degencast
• License: mit
• Created: 2023-02-15T06:46:28.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-21T06:35:40.000Z (10 months ago)
• Last Synced: 2024-12-24T04:31:26.946Z (12 days ago)
• Topics: ceramic, ceramic-network, ipfs, web3
• Language: TypeScript
• Homepage: https://scan.s3.xyz
• Size: 7.83 MB
• Stars: 28
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Ceramic Network

Ceramic is a shared data network for managing verifiable data at scale, providing the trust of a blockchain with the flexibility of an event streaming system.

## S3

S3 is a Node-as-a-Service Social, supporting Layer 2 networks, rollups and storage network like Ceramic, with coming support for FVM IPC, OP-Stack for unparalleled performance.

S3 provides developer tools and services for building on Layer 2 and rollup networks. It is completely open source.

S3 allows developers to easily build applications leveraging primitives like Ceramic for data storage and sharing. With S3's services, developers can quickly view, monitor, and manage data on these networks.

Upcoming support for FVM IPC and OP-Stack will enable even faster and more efficient operations across various rollup networks.

The initial focus is on Ceramic integration, but the goal is to support additional rollup networks beyond just Ceramic in the future.

## Packages

This repo contains the following packages:

DevelopmentDevelopment

### US3R-Scan

US3R-Scan is an explorer for the Ceramic network that indexes all Ceramic streams in real-time.

Key features:

- Search and view any public Ceramic stream

- See real-time updates as streams are changed

- View stream metadata like schema and controllers

- Monitor overall network activity and stream creation

- Website: https://scan.s3.xyz

- Code: packages/server, packages/client/scan

### US3R-Dashboard

US3R-Dashboard provides a management dashboard for Ceramic streams.

Key features:

- Create, update, and view your streams

- Easily manage stream metadata like schema, controllers, and tags

- Monitor activity on your streams

- Integration with 3ID Connect for authentication

- Website: https://dashboard.s3.xyz

- Code: packages/client/dashboard

## Repo Structure

`packages/server` - Backend server code

`packages/client` - Frontend client code

`scan` - Code for the US3R-Scan client

`dashboard` - Code for the US3R-Dashboard client

`docker` - Docker related config files

`docs` - Documentation

## Development

S3 ships with a [Docker Compose](https://docs.docker.com/compose/) configuration for setting up a local development and testing environment.  

Make sure you have [Docker and Compose installed](https://docs.docker.com/compose/install/), then follow the instruction of [Userscan Server README](./packages/server/README.md)