From ea32191407fa52e449833ddb72d0f6ee4d9b71f5 Mon Sep 17 00:00:00 2001 From: SimpleCookie Date: Fri, 2 May 2025 09:32:48 +0200 Subject: [PATCH 1/4] Add requirements to README.md --- README.md | 116 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 61 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 48861b29..9d034aa7 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,61 @@ -# Dotabod Frontend 👨‍💻 - -Welcome to the open source UI for Dotabod! This repository includes the overlay used in OBS, a dashboard to manage all settings, and the https://dotabod.com homepage. - -## About Dotabod 🎮 - -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. - -## Installation 🛠️ - -1. Clone the repository & copy the example environment file - - ```bash - git clone https://github.com/dotabod/frontend.git - cd frontend - - # Fill out the values in .env with your own - cp .env.example .env - ``` - -1. Install dependencies - - ```bash - yarn install - ``` - -1. Setup your postgres database - - ```bash - yarn prisma db push - ``` - -1. Start the development server - - ```bash - yarn dev - ``` - -1. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -1. [Alter the frontend to use moderator scopes](https://github.com/dotabod/frontend/blob/3d884389f4b448fcf67ce5c149f265bbe9394ee4/src/lib/auth.ts#L42), then login with your chatbot - -1. Undo the moderator scope changes and login with a normal twitch user that you want to stream on - -## Contributing 🤝 - -We welcome contributions from the community! Whether you want to submit a bug report, suggest a new feature, or contribute code, we would love to hear from you. Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information. - -## License 📝 - -This project is licensed under the [MIT License](LICENSE). - -![Alt](https://repobeats.axiom.co/api/embed/ea30ccaa0e412de306ca98de53ea20d18cfdfa37.svg 'Repobeats analytics image') - -Vercel Logo +# Dotabod Frontend 👨‍💻 + +Welcome to the open source UI for Dotabod! This repository includes the overlay used in OBS, a dashboard to manage all settings, and the https://dotabod.com homepage. + +## About Dotabod 🎮 + +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: `npm install -g yarn` to install yarn globally +- Bun: `npm install -g bun` to install bun globally + +## Installation 🛠️ + +1. Clone the repository & copy the example environment file + +```bash +git clone https://github.com/dotabod/frontend.git +cd frontend + +# Fill out the values in .env with your own +cp .env.example .env +``` + +1. Install dependencies + +```bash +yarn +``` + +1. Setup your postgres database + +```bash +yarn prisma db push +``` + +1. Start the development server + +```bash +yarn dev +``` + +1. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. + +1. [Alter the frontend to use moderator scopes](https://github.com/dotabod/frontend/blob/3d884389f4b448fcf67ce5c149f265bbe9394ee4/src/lib/auth.ts#L42), then login with your chatbot + +1. Undo the moderator scope changes and login with a normal twitch user that you want to stream on + +## Contributing 🤝 + +We welcome contributions from the community! Whether you want to submit a bug report, suggest a new feature, or contribute code, we would love to hear from you. Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information. + +## License 📝 + +This project is licensed under the [MIT License](LICENSE). + +![Alt](https://repobeats.axiom.co/api/embed/ea30ccaa0e412de306ca98de53ea20d18cfdfa37.svg "Repobeats analytics image") + +Vercel Logo From 9da18a87ef576c2f93ef2bdc02b06283b5aef89a Mon Sep 17 00:00:00 2001 From: SimpleCookie Date: Fri, 2 May 2025 09:47:25 +0200 Subject: [PATCH 2/4] Recommit with LF --- README.md | 122 +++++++++++++++++++++++++++--------------------------- 1 file changed, 61 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 9d034aa7..d898730a 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,61 @@ -# Dotabod Frontend 👨‍💻 - -Welcome to the open source UI for Dotabod! This repository includes the overlay used in OBS, a dashboard to manage all settings, and the https://dotabod.com homepage. - -## About Dotabod 🎮 - -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: `npm install -g yarn` to install yarn globally -- Bun: `npm install -g bun` to install bun globally - -## Installation 🛠️ - -1. Clone the repository & copy the example environment file - -```bash -git clone https://github.com/dotabod/frontend.git -cd frontend - -# Fill out the values in .env with your own -cp .env.example .env -``` - -1. Install dependencies - -```bash -yarn -``` - -1. Setup your postgres database - -```bash -yarn prisma db push -``` - -1. Start the development server - -```bash -yarn dev -``` - -1. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -1. [Alter the frontend to use moderator scopes](https://github.com/dotabod/frontend/blob/3d884389f4b448fcf67ce5c149f265bbe9394ee4/src/lib/auth.ts#L42), then login with your chatbot - -1. Undo the moderator scope changes and login with a normal twitch user that you want to stream on - -## Contributing 🤝 - -We welcome contributions from the community! Whether you want to submit a bug report, suggest a new feature, or contribute code, we would love to hear from you. Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information. - -## License 📝 - -This project is licensed under the [MIT License](LICENSE). - -![Alt](https://repobeats.axiom.co/api/embed/ea30ccaa0e412de306ca98de53ea20d18cfdfa37.svg "Repobeats analytics image") - -Vercel Logo +# Dotabod Frontend 👨‍💻 + +Welcome to the open source UI for Dotabod! This repository includes the overlay used in OBS, a dashboard to manage all settings, and the https://dotabod.com homepage. + +## About Dotabod 🎮 + +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: `npm install -g yarn` to install yarn globally +- Bun: `npm install -g bun` to install bun globally + +## Installation 🛠️ + +1. Clone the repository & copy the example environment file + +```bash +git clone https://github.com/dotabod/frontend.git +cd frontend + +# Fill out the values in .env with your own +cp .env.example .env +``` + +1. Install dependencies + +```bash +yarn +``` + +1. Setup your postgres database + +```bash +yarn prisma db push +``` + +1. Start the development server + +```bash +yarn dev +``` + +1. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. + +1. [Alter the frontend to use moderator scopes](https://github.com/dotabod/frontend/blob/3d884389f4b448fcf67ce5c149f265bbe9394ee4/src/lib/auth.ts#L42), then login with your chatbot + +1. Undo the moderator scope changes and login with a normal twitch user that you want to stream on + +## Contributing 🤝 + +We welcome contributions from the community! Whether you want to submit a bug report, suggest a new feature, or contribute code, we would love to hear from you. Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information. + +## License 📝 + +This project is licensed under the [MIT License](LICENSE). + +![Alt](https://repobeats.axiom.co/api/embed/ea30ccaa0e412de306ca98de53ea20d18cfdfa37.svg "Repobeats analytics image") + +Vercel Logo From 7132665ec2fc8ecf93885228426dc74f6f570879 Mon Sep 17 00:00:00 2001 From: SimpleCookie Date: Fri, 2 May 2025 09:50:48 +0200 Subject: [PATCH 3/4] Revert to single-quote --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d898730a..a814d901 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,6 @@ We welcome contributions from the community! Whether you want to submit a bug re This project is licensed under the [MIT License](LICENSE). -![Alt](https://repobeats.axiom.co/api/embed/ea30ccaa0e412de306ca98de53ea20d18cfdfa37.svg "Repobeats analytics image") +![Alt](https://repobeats.axiom.co/api/embed/ea30ccaa0e412de306ca98de53ea20d18cfdfa37.svg 'Repobeats analytics image') Vercel Logo From aca06babab96178759e779e5961296ad6d3bedac Mon Sep 17 00:00:00 2001 From: Marcus Date: Wed, 7 May 2025 21:56:29 +0200 Subject: [PATCH 4/4] Link to respective official installation page --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a814d901..26e18759 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@ Dotabod is a platform designed to enhance the experience of Dota 2 streamers and ## 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: `npm install -g yarn` to install yarn globally -- Bun: `npm install -g bun` to install bun globally +- 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 🛠️