Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,41 @@ Welcome to the open source UI for Dotabod! This repository includes the overlay

Dotabod is a platform designed to enhance the experience of Dota 2 streamers and viewers. By providing real-time stats, twitch bets, mmr tracking, and more, Dotabod allows viewers to engage with Dota 2 streams in new and exciting ways.

## Requirements

- Node: Expected version "^18.0.0 || ^20.0.0 || >=22.0.0". If it's a fresh install then >= v22 is recommended as it has long term support.
- Yarn: [https://classic.yarnpkg.com/lang/en/docs/install](https://classic.yarnpkg.com/lang/en/docs/install)
- Bun: [https://bun.sh/](https://bun.sh/)

## Installation 🛠️

1. Clone the repository & copy the example environment file

```bash
git clone https://github.com/dotabod/frontend.git
cd frontend
```bash
git clone https://github.com/dotabod/frontend.git
cd frontend

# Fill out the values in .env with your own
cp .env.example .env
```
# Fill out the values in .env with your own
cp .env.example .env
```

1. Install dependencies

```bash
yarn install
```
```bash
yarn
```

1. Setup your postgres database

```bash
yarn prisma db push
```
```bash
yarn prisma db push
```

1. Start the development server

```bash
yarn dev
```
```bash
yarn dev
```

1. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

Expand Down