Quickstart

The best way to understand the project is to just try it!

The project is open-source and we are looking for contributors.

Prerequisites

  • Node LTS

Then, simply run these commands:

git clone [email protected]:Vija02/TheOpenPresenter.git

cd TheOpenPresenter

# Enable corepack & install yarn
corepack enable
corepack use yarn

# Setup deps & local DB
yarn && yarn local-dev

# On another terminal, start the server
yarn dev

You should then be able to access the project through http://localhost:5678

Future runs

For future runs, you only need to run yarn local-dev to run the DB, and yarn dev to run the server itself.

yarn dev might take a long time to resolve since it's watching every single package in the repo. If you know which file you're modifying, you can watch only that package by going to its folder and running yarn dev there.

We're constantly improving the development experience of TheOpenPresenter. If these steps doesn't work, please let us know!

Last updated