River

Set information free.

Background

River facilitates the organization of onchain information in a user friendly way – designed to evoke the feeling of blogs, archives, and databases.

The codebase consists of frontend, backend, and protocol (separate repo) sections that combine to provide the rails for our platform and those who intersect it.

Please see the local development instructions in the README.md for each section. Everything you see is under active development – use code at your own risk.

Getting Started

Clone the repository:

$ git clone https://github.com/1ifeworld/river.git

Ensure your pnpm version is up to date, then install dependencies:

$ pnpm install

Lastly, run the development server:

$ pnpm dev

Contributions

If you're prepared to add a feature/squash a bug, kindly create a pull request that includes comprehensive commit messages.

Before you submit your PR, run all of the following from the root directory and commit the changes:

# lint code
pnpm lint

# format code
pnpm format

Additionally, ensure that you review the project's open issues and link your pull request to a relevant one, if applicable.

For more detailed guidelines on the contribution process and setting up a local development environment, click here.