Skip to content

frolleks/distra

Repository files navigation

distra

An open source video sharing site.

Stack

Contributing guide

Prerequisites

  • Git
  • Node.js 18.12.x or later
  • pnpm
  • PostgreSQL database

After you install Node.js, run corepack enable pnpm to enable pnpm.

Then, fork and clone the forked repository.

git clone https://github.com/<your username>/distra
cd distra

Then, install the dependencies.

pnpm i

Then, you'd need to have an instance of PostgreSQL running, I won't give you a guide because there's a lot of them. I'd recommend you to use Docker for this.

Then, create a .env file, with the database url inside it.

DATABASE_URL="postgres://postgres:mydbpassword@localhost:5432/postgres

Then, migrate the database schema to the database.

pnpm migrate

And then, run the development server.

pnpm run dev

Happy coding!

When you're done making your changes, open up a pull request in the main repository.