An open API service indexing awesome lists of open source software.

https://github.com/cchampou/twibi

Cross Twitch & and social network system, with notifications, chatbots & more...
https://github.com/cchampou/twibi

discord eventsub irc twitch typescript websocket

Last synced: over 1 year ago
JSON representation

Cross Twitch & and social network system, with notifications, chatbots & more...

Awesome Lists containing this project

README

          

# Twibi
[![CI](https://github.com/cchampou/twibi/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/cchampou/twibi/actions/workflows/CI.yml)
[![codecov](https://codecov.io/gh/cchampou/twibi/branch/main/graph/badge.svg?token=ESW60FVUMJ)](https://codecov.io/gh/cchampou/twibi)

Cross Twitch & and social network system, with notifications, chatbots & more...

---

## Prerequisite

To run development environment of Twibi, you need:

- NodeJS >= 14
- Docker

First you need to create a local configuration. Use the file `.env.local`,
and fill it with your values.

Then you need to start a development database. Use
```shell
docker-compose up dev-database
```

Install `node_modules`
```shell
yarn install
# or
npm install
```

> 💡 I suggest using Yarn, this is what I use on a daily basis

Then, you need to start a build server, with watchers on.
```shell
yarn build:dev
```

Finally, you can start a dev server with watchers on.
```shell
yarn start:dev
```

Happy coding 🎉