forza11879/kittr

Welcome to kittr

Getting Started

Prerequisites

• Docker Desktop
• If you are on Windows, make sure that you switch your Docker Desktop to Linux containers. You won't be able to spin up the docker compose containers without it!
• Node.js
• yarn

Installation

1. Clone the repo

git clone https://github.com/kittrgg/kittr.git

2. Checkout the migration branch

git checkout migration

3. Let's get your environment variables set up. Navigate in your file explorer to /scripts/createEnvironment/inputs.

• Copy the example.env.json file to a new file called dev.env.json.
• Provide values for TWITCH_CLIENT_ID and TWITCH_SECRET.
  • We can't provide you with these values because they are indiviual to you. To get your Twitch tokens, visit your Twitch developers console and create an application token. (For the URLs that it asks for, you can use http://localhost:3000.)

4. Run yarn install.

5. Run yarn env:dev.

6. Run yarn dx.

7. If this is your first time developing kittr, you will need to seed your local Mongo instance at this time. To do so, open a new shall and use yarn dx:mongo-seed. You should get a message saying "Let's get kittd."

8. Now, run yarn dx:db-seed in that new shell, too. This takes the data from MongoDB to Postgres so you can use it for our migration.

9. Visit kittr at http://localhost:3000

Ports

When working locally, these ports are available:

• Web front-end: http://localhost:3000

• Documentation: http://localhost:3001

• API: http://localhost:5000

• Mongo Express: http://localhost:5001 (View your Mongo data in your browser!)

• Mongo: http://localhost:27017 (You shouldn't need to interact with this port directly.)

• Firebase Emulator UI: http://localhost:4000

• Firebase Auth Emulator: http://localhost:4001 (You shouldn't need to interact with this port directly.)

• Firebase Storage Emulator: http://localhost:4002 (You shouldn't need to interact with this port directly.)

Contributing

Contributions are encouraged from junior and senior developers alike. You may check the issues on this project to find out what needs working on.

PLEASE make sure that before you attempt to make any major changes to kittr that you ask the maintainers first. There is a business vision here that you may not be privvy to. (We will try to make the long-term plans for kittr more accessible as we continue this effort.)

1. Fork the Project

2. Checkout the develop branch (git checkout develop)

3. Create your Feature Branch (git checkout -b new-branch)

4. Commit your Changes (git commit -m 'New Changes') (Please provide the maintainers with a nice commit message to state your intentions on what this commit should include!)

5. Push to the Branch (git push origin new-branch)

6. Open a Pull Request

   You can find an instructional video on this process here

Notes

• Existing login credentials to get into the dashboard:
  • Username: anthony@dev.com
  • Password: 123123
• A few channels that you may find useful:
  • ALLKITS - Features every kit in the database (well, almost) (may no longer be in the seed...)
  • brandnewchannel - A fresh, empty channel that was just created
  • anthonyshew - A channel that features multiple managers so you can see how the dashboard changes based on the user's role in that channel