GetSkills.live

Bring skills to your stream using Channel Points.
View site

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact

About The Project

This project makes it easy to create experiences for your viewers using channel points. It will be used to change your scenes (Streamlabs OBS, OBS), to show animations and sounds, to create bidding systems, or even to connect to your led lights or other devices.

Built With

• NestJS
• Next.js
• TypeScript
• MongoDB

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Node.js
• MongoDB
• Yarn 1.x

Installation

1. Clone the repo

   git clone https://github.com/enriquebv/getskills.git

2. Install modules

   yarn

3. Install packages

   yarn lerna bootstrap

4. Build front-end & back-end

   yarn lerna run build

5. Remove .example suffix from /packages/backend/.env.example file and set real values.

    # Stage
    APP_ENV=development
    APP_URL=http://localhost:3000
   
    # Security
    JWT_SECRET=123456
    ALLOWED_ORIGINS=http://localhost:8080
    ALLOWED_COOKIE_DOMAIN=localhost
   
    # Persistence
    MONGODB_URI=mongodb://localhost/getskillsdb
   
    # Misc
    APP_DEBUG=true
   
    TWITCH_CLIENT_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX # Twitch App Client ID
    TWITCH_CLIENT_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX # Twitch App Secret
    TWITCH_WEBHOOK_SECRET=12345678910
   
    DISCORD_CONTACT_WEBHOOK=https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXX # Discord channel webhook url

6. Remove .example suffix from /packages/frontend/.env.local.example files and write with real values.

   NEXT_PUBLIC_TWITCH_CLIENT_ID=XXXXXXXXXXXXXXXXXXXXXXXXXX # Twitch App Client ID
   NEXT_PUBLIC_TWITCH_CALLBACK_URL=http://localhost:8080/callback
   NEXT_PUBLIC_API_SERVER=http://localhost:3000

You must need a MongoDB server to store the data. If you dont have any, run: yarn docker:install and yarn docker:start. You will need Docker.

Contact

Enrique Bernabeu - @enriquedev_ - [email protected]

Project Link: https://github.com/enriquebv/getskills