kyscott18 / river

Set information free.

River

Set information free.

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.

More detailed guidelines on the contribution process and setting up a local development environment are in the works.