- captain-fact-api: Elixir / Phoenix / Absinthe backend
- captain-fact-frontend: React frontend
- captain-fact-extension: Browser extension, built with React and WebExtensions
- captain-fact-overlay-injector: Video overlay injector, built with Preact
To setup the dev environment, please refer to the different repositories instructions
from their README.md. The general rule here is:
-
You don't need to clone the API to work on the frontend, there's a
docker-compose.ymlready. -
All projects are configured with smart defaults so you can start all of them on your local machine and they will behave properly.
-
Code must be formatted, either with
mix.formatfor the API or using prettier for npm projects. -
We value clear commits messages, clear branches names, detailed pull requests
-
Want to help but don't know where to start with? Look for the
good first issuelabel.