Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 1.63 KB

👩‍💻 Contributing

Right now Twitch Live Polls is not actively seeking new contributors. That being said, the right PR will always get merged 😎.

Install Pre-Commit Hooks

Before starting development, be sure to install pre-commit and our corresponding hooks! This will ensure the PR process goes smoothly.

pip install pre-commit
pre-commit install

Development Setup

The development setup guide is quite similar to the Quickstart that is found in the README

Copy the example config into a config.yaml for use with the development Docker Compose configuration

cd backend
cp config-example.yaml config.yaml

Edit the example config to point to your Twitch channel. This can be found under Voting > ChannelName. Edit the example config to point to the correct cache instance. Change Server > Cache > Host from prod-cache to cache for compatibility with the development Docker Compose.

Copy the example secrets file into secrets.yaml for use with the development Docker Compose configuration

cp secrets-example.yaml secret.yaml

Edit the file to include a LONG and RANDOM token for authenticating to your server endpoints. This can be found under Server > Token.

Spin up the Docker Compose. The service will now be listening on localhost:3000.

docker compose up

Frontend Setup

Create a .env file that points at your backend for the NEXT_PUBLIC_API_URL

cd ..
cd frontend
echo 'NEXT_PUBLIC_API_URL="localhost:3000"' > .env

Run the NextJS development command. The app will be served on localhost:4200.

npm run dev