Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mirrorworld-universe/cascade-protocol
A Solana explorer for humans
https://github.com/mirrorworld-universe/cascade-protocol
cascade explorer rollup solana svm ux
Last synced: 21 days ago
JSON representation
A Solana explorer for humans
- Host: GitHub
- URL: https://github.com/mirrorworld-universe/cascade-protocol
- Owner: mirrorworld-universe
- Created: 2024-06-21T11:47:44.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-12T17:10:19.000Z (6 months ago)
- Last Synced: 2024-07-13T18:23:53.401Z (6 months ago)
- Topics: cascade, explorer, rollup, solana, svm, ux
- Language: TypeScript
- Homepage: https://cascade.sonic.game
- Size: 1.68 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Solana's human-readable explorer. 🌊
This repository comprises of two kinds of workspaces:
- **Packages**:
- [**Core**](./packages/core): The core package provides the basic building blocks for building Solana-first dApps.
- [**React**](./packages/react): The React package provides a React hooks for building Solana-first dApps, making them easy to use for the end user.
- **Apps**:
- [**Cascade Explorer**](./apps/explorer): The Cascade Explorer is a web application that allows users to explore the Solana blockchain and interact with programs deployed on Solana or any SVM Rollup.
- [**Cascade Wallet**](./apps/wallet): The Cascade Wallet is a web application that allows users to interact with programs deployed on Solana or any SVM Rollup.
### npm Packages
| Package | Link | Version |
| :---------------------------- | :------------------------------------------ | :--------------------------------------------- |
| **`@cascade-protocol/core`** | [cascade-protocol-core][cascade-core-npm] | [![NPM][cascade-core-img]][cascade-core-npm] |
| **`@cascade-protocol/react`** | [cascade-protocol-react][cascade-react-npm] | [![NPM][cascade-react-img]][cascade-react-npm] |
## Installation
This repository is a monorepo managed with [bun](https://bun.sh/).
To install the dependencies, run `bun install`.
```
bun install
```
## Local database setup (optional)
We use PostgresQL to store a few things:
- Price history for the SOL in USD
This in only optional, and is used to ensure that migrations are executed will for further additions to the stack.
Install Postgres locally and create a local database called `cascade_db_local`.
Create a `.env` file in the `apps/api/.env` directory with the following variables:
```env
DATABASE_USERNAME=
DATABASE_PASSWORD=
DATABASE_HOST=127.0.0.1
DATABASE_PORT=5432
DATABASE_NAME="cascade_db_local"
```
Run the migration script:
```sh
bun run --filter=@cascade-protocol/api ./db/migrate.ts
```
## Contributing
Feel like contributing? That's awesome! We have a
[contributing guide](./CONTRIBUTING.md) to help guide you.
[cascade-core-npm]: https://npmjs.com/package/@cascade-protocol/core
[cascade-react-npm]: https://npmjs.com/package/@cascade-protocol/react
[cascade-vue-npm]: https://npmjs.com/package/@cascade-protocol/vue
[cascade-core-img]: https://img.shields.io/npm/v/@cascade-protocol/core?logo=typescript
[cascade-react-img]: https://img.shields.io/npm/v/@cascade-protocol/react?logo=typescript
[cascade-vue-img]: https://img.shields.io/npm/v/@cascade-protocol/vue?logo=typescript
# License
MIT