Welcome to the repository for the 8by8 Challenge! The 8by8 Challenge is a web application intended to foster civic engagement by allowing users to perform various actions such as registering to vote or signing up for election reminders in exchange for badges. Users can also share their challenge with friends via social media. When an invited user registers to vote, or takes another similar action, the inviter also receives a badge. When a user receives 8 badges within 8 days, they have completed their challenge and will earn a reward.
Currently, we are working on migrating the existing application to Next.js and TypeScript, as well as fixing bugs, improving accessibility, etc. For the existing application's source code, please visit https://github.com/8by8-org/web-app.
You must have Node.js version 18.17+. Docker is strongly recommended for local development with Supabase, but you may also create your own Supabase project if you cannot install Docker.
To run the application locally, fork the repository and clone the fork to your machine. In the terminal, navigate into the project directory and run npm install. This will install the project's dependencies.
Copy the contents of .env.example into a file named .env.
Replace the values of the variables inside .env with appropriate entries. Values for turnstile keys can be found here: https://developers.cloudflare.com/turnstile/troubleshooting/testing/
Values for Supabase variables will be displayed in the terminal after running either npm run supabase-dev:start or npm run supabase-test:start. These values will be
the same for both commands, and will be the same each time you run these commands.
To create a CryptoKey to add as the value for the VOTER_REGISTRATION_REPO_ENCRYPTION_KEY, run npm run create-cryptokey.
- Python: Ensure Python is installed on your system. Documentation.
- Selenium: Python package for browser automation. Documentation.
- Pytest: Python package for unit testing. Documentation.
- Drivers: Included with Selenium version 4.6.0 and higher. Documentation.
While our project can run on different versions of Python, it is best practice to use Python 3 for better performance, security, and compatibility with modern libraries and frameworks.
If you do not have Python 3 installed, you can download it from the official Python website.
python --version
The command to run Python might be python3 on some systems (like Ubuntu and WSL), while in other environments it might just be python. Please adjust the commands accordingly based on your environment.
- Ubuntu (including WSL)
- CentOS/RHEL (recent versions)
- Fedora
- macOS (often default)
- Older Linux distributions (e.g., Ubuntu 12.04, CentOS 6)
- Conda Environments
- Docker Containers
python3 -m venv venv
macOS
source venv/bin/activate
Windows
venv\Scripts\activate
Linux
source venv/bin/activate
Selenium does not need to be installed on a per-project basis. To see if you already have it installed, you can run the following command:
pip show selenium
If installed, it will print information about the package. If the version is less than 4.6.0, you should update it by running:
pip install -U selenium
Otherwise, you can install it by running the following command:
pip install selenium
For more information on installing Selenium, see this.
For information on upgrading Selenium, see this.
Be sure to install pytest:
pip install pytest
To ensure that Selenium tests run efficiently, it is recommended to first compile your project using npm run build. This step improves performance by compiling and optimizing the code, which can make the tests smoother.
I. Build the Project:
npm run build
II. Start Development Server:
npm run start
To run the Selenium tests, navigate into src/__tests__/e2e and run
python3 -m pytest.
New engineers should review CONTRIBUTING.md for details about the recommended workflow and tools.