Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Latest commit

 

History

History
30 lines (17 loc) · 1.41 KB

File metadata and controls

30 lines (17 loc) · 1.41 KB

Contributing to River

Thank you for showing interest in improving River. If you have any questions about this guide, have suggestions, or have any trouble getting started, please open an issue.

Installing Dependencies

Ensure the following packages are globally installed and up-to-date on your machine:

Then, run the following command from the root folder:

pnpm install

Navigating the Monorepo

There are three main components of this repository, the Next.js app that powers the River frontend, located at apps/frontend, the Ponder instance powering the backend, located at apps/backend, and the River design system, Estuary, located at packages/estuary.

If you're looking for our protocol repository, click here.

Configuring Environment Variables

Visit the 'env.example' file in each directory for guidance on how to configure your environment variables. Below, you'll find links to retrieve the necessary API keys we use.

If you have suggestions on a better approach to configuring environment variables for this project, please open an issue.