Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enriquebv/getskills
https://github.com/enriquebv/getskills
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/enriquebv/getskills
- Owner: enriquebv
- Created: 2021-02-03T19:13:10.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-16T16:07:28.000Z (over 3 years ago)
- Last Synced: 2023-02-27T10:33:01.261Z (almost 2 years ago)
- Language: TypeScript
- Homepage: getskills-git-master.enriquebv.vercel.app
- Size: 1.67 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
Bring skills to your stream using Channel Points.
View site
Table of Contents
## 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](https://nestjs.com/)
- [Next.js](https://nextjs.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [MongoDB](https://www.mongodb.com/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- [Node.js](https://nodejs.org/)
- [MongoDB](https://www.mongodb.com/)
- [Yarn 1.x](https://classic.yarnpkg.com)
### Installation
1. Clone the repo
```sh
git clone https://github.com/enriquebv/getskills.git
```
2. Install modules
```sh
yarn
```
3. Install packages
```sh
yarn lerna bootstrap
```
4. Build front-end & back-end
```sh
yarn lerna run build
```
5. Remove `.example` suffix from `/packages/backend/.env.example` file and set real values.
```bash
# 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.
```bash
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\_](https://twitter.com/enriquedev_) - [email protected]
Project Link: [https://github.com/enriquebv/getskills](https://github.com/enriquebv/getskills)