This is the codebase for the open source Metaculus website. This readme is a work in progress. Feel free to suggest edits or open an issue if you have any questions.
If you make a meaningful contribution to the Metaculus codebase, e.g. solving an issue we'll send you a Metaculus hoodie (please email the shipping address to christian@metaculus.com)
If you want to contribute, set up a local development environment using the instructions below. Create an issue if you are having problems doing so.
We curate a list of issues suitable for newcomers. It's a great place to start.
Feel free to suggest your own changes and ideas as an issue. We'll discuss it and help you get started on implementing it.
To run this project locally, you'll need python, poetry, django, postgres, redis, and npm/node. This will be a quick rundown of the setup process. (Note: all commands written for a unix bash shell)
Create a .env
file in the front_end directory of the project by copying the .env.example
file.
This will hold all of the environment variables that are used by the project. For example, adding DEBUG=true
will give you access to the django debug toolbar in browser.
Install Postgres - your database manager:
sudo apt install postgresql
If on Mac, you can instead do
brew install postgresql
Create a database:
You'll need to create a database for the data. The default name will be metaculus
which is how it is referenced throughout this codebase, but if you name yours differently you may have to change some commands and a few instances within files. (TODO: list locations in codebase to change)
sudo -u postgres psql # start up postgres
If on Mac, you can instead do brew services start postgresql
to start up postgres.
Then in the postgres shell:
CREATE DATABASE metaculus;
You may have to give metaculus a superuser as an owner, which you can do with:
CREATE USER postgres WITH SUPERUSER;
ALTER USER postgres WITH PASSWORD 'postgres';
ALTER DATABASE metaculus OWNER TO postgres;
Note: to leave psql, type \q
Next, add the database name to your .env
file:
DATABASE_URL=postgres://postgres:postgres@localhost:5432/metaculus
You may have to start postgresql manually when starting your server. You can do this by running sudo service postgresql start
The last step in getting your database ready is adding the pgvector database extension: Note: Replace 16 with your Postgres server version
sudo apt install postgresql-16-pgvector
Installing pgvector on Mac:
git clone https://github.com/pgvector/pgvector.git
cd pgvector
- Find out your
pg_config
path\ A few common paths on Mac are:
- EDB installer:
/Library/PostgreSQL/16/bin/pg_config
- Homebrew (arm64):
/opt/homebrew/opt/postgresql@16/bin/pg_config
- Homebrew (x86-64):
/usr/local/opt/postgresql@16/bin/pg_config
\ Note: Replace 16 with your Postgres server versionexport PG_CONFIG=path/to/pg_config
make
make install
- Connect to psql and enable extension:
CREATE EXTENSION vector;
Other installations and detailed instructions - https://github.com/pgvector/pgvector
Then enable the extension:
sudo -u postgres psql # start up postgres
CREATE EXTENSION vector;
You'll need redis for caching and some background tasks. Install redis:
sudo apt install redis-server
You can start redis with sudo service redis-server start
That should be it for redis.
If on Mac, you can instead do brew install redis
to install redis, and brew services start redis
to start redis.
You'll need to install python version 3.12.3 (or higher), and we use poetry for dependency management. We recommend using pyenv to manage python versions. Install pyenv:
curl https://pyenv.run | bash
Then, install python 3.12.3:
pyenv install 3.12.3
pyenv global 3.12.3
Install poetry:
curl -sSL https://install.python-poetry.org | python3 -
If all is installed properly, you should be able to run poetry --version
.
It is also useful to know that you can run poetry env use 3.12.3
to switch to a specific python version. And to use poetry shell
to enter a poetry shell so you won't have to prefix all of the python commands with poetry run
.
With that, you should be good to start installing the python dependencies.
poetry install
You'll need node to build the frontend. We use nvm for managing node versions. Install nvm with:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
Then, install node 18.17.0:
nvm install 18.17.0
nvm use 18.17.0
To install the frontend dependencies, run:
cd front_end
npm install
Note: you have to switch to the front_end directory to run the npm commands as they are all nested there.
The first time you're booting up the server, make sure postgres is running (sudo service postgresql start
), then you'll need to run the migrations and collect static files. Start by navigating to the root directory.
Running migrations:
poetry run python manage.py migrate
Collecting static files:
poetry run python manage.py collectstatic
Then you can run the server with:
poetry run python manage.py runserver
Running the front end is pretty easy. Note that you'll have to navigate to the font_end
directory first.
cd front_end
npm run dev
We use dramatiq for our task broker. To run it, you'll need to run the following command:
poetry run python manage.py rundramatiq
This will handle asynchronous tasks such as scoring questions, evaluating metrics like "movement", and processing notifications.
Here are some other useful things to know about
We use mjml to generate html emails. To edit emails, you'll edit a mjml template and in order to have the html automatically updated, you'll need to run the following command:
poetry run python manage.py mjml_compose
If you want to populate your database with some example data, you can load our testing database dump (available as a release artifact).
wget https://github.com/Metaculus/metaculus/releases/tag/v0.0.1-alpha/test_metaculus.sql.zip
unzip test_metaculus.sql.zip
pg_restore -d metaculus test_metaculus.sql
If on Mac, you can replace the wget command with
curl -O https://github.com/Metaculus/metaculus/releases/tag/v0.0.1-alpha/test_metaculus.sql.zip
Then run migrations to make sure the database is up to date:
poetry run python manage.py migrate
To run the backend tests, you can run:
poetry run pytest
If you get an error that the playwright executable doesn't exist, run poetry run python -m playwright install
.
(TODO: add front end testing) When contributing to the project, adding tests is highly encouraged and will increase the likelihood of your PR being merged.
We use Husky to run linter and typescript checks before committing (see front_end/.husky
).
To enable restricted Dev access, you need to add ALPHA_ACCESS_TOKEN=<token>
as an env variable for both the BE and the FE (both the FE server & the env where the FE is compiled, which should be the same in most cases)
We use Django Anymail to integrate various email providers through a single library, simplifying our email management By default, we use the Mailgun provider.
.env
Configuration:
MAILGUN_API_KEY
EMAIL_HOST_USER
Our bug bounty system classifies vulnerabilities as one of the following:
hard to exploit
easy to exploit
limited in scope
broad in scope
Bounty payouts:
Please email all such vulnerabilities to: engineering@metaculus.com with the subject Security Vulnerability
Note: This bug bounty system begins September 10th, 2024. Before that point we will still award $100 for security vulnerabilities, but we expect an internal audit to catch most of these.
Note: The first reporter receives the bounty. If multiple reports occur within a few minutes of each other, the prize will be split.
Note: Making the exploit public will annul the bounty.