Politicry

Politicry is a browser extension to filter political posts from your feed on popular social media sites such as Reddit. Currently, we only support the Chrome browser, but in the future hope to expand support to include other browsers, such as Firefox.

Installation

1. Download and unzip the latest release.
2. Visit chrome://extensions/ in your Chrome browser.
3. Toggle Developer mode.
4. Click on the "Load unpacked" button.
5. Select the unzipped folder.
6. The Politicry extension card should show in your list of extensions.

For Developers

If you would like to download the current, unreleased version of the extension in this repository:

1. Build the extension as per the instructions below.
2. Follow the instructions above, using the politicy/extension/dist folder instead.

Prerequisites

• Install yarn: npm install --global yarn
• Install Docker. You may also need to install the WSL 2 Linux kernel if Docker Desktop prompts you to.
• Open Docker Desktop
• Clone this repository and open it in the terminal.

Development

Run Backend:

docker-compose -f docker-compose.dev.yml up -d # start the backend

## other useful commands ##

docker-compose -f docker-compose.dev.yml logs -f # view logs of backend
docker-compose -f docker-compose.dev.yml down # stop the backend

If this does not work, please try the top solution here

Build Extension:

cd extension
yarn # install modules

# build the extension, this will export to extension/dist
yarn build
ENVIRONMENT=dev yarn build # for Linux

Run Tests for Extension

cd extension
yarn test # (or "npm test")

# to collect code coverage, and run all tests immediately, use this command instead:
yarn test:ci

Run Tests for Website

cd website
yarn test # (or "npm test")

Run Code formatter and lint tool

# cd into the root directory of this repository
yarn # first time only
yarn lint

Running this script will fix any formatting issues and report issues that could not be fixed.

Deployment

cp .example.env .env

docker-compose -f docker-compose.yml --env-file .env up -d

Licensing and Contribution

Unless otherwise specified, all contributions will be licensed under MIT. For further details see the contributing guidelines.