> For the complete documentation index, see [llms.txt](https://docs.theopenpresenter.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.theopenpresenter.com/development/quickstart.md).

# Quickstart

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

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

{% embed url="<https://github.com/Vija02/TheOpenPresenter>" %}

### Prerequisites

* Node LTS

Then, simply run these commands:

```bash
git clone git@github.com:Vija02/TheOpenPresenter.git

cd TheOpenPresenter

# Enable corepack & install yarn
# Note: You may need to run this as admin in Windows
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.

{% hint style="info" %}
We're constantly improving the development experience of TheOpenPresenter. If these steps doesn't work, please let us know!
{% endhint %}