Please read our contributing guidelines to understand how to setup your development environment including pre-commit hooks.
After forking facebookresearch/dynabench to your own GitHub account, clone the forked repo using:
git clone git@github.com:{your_github_username}/dynabench.git
cd dynabench
The backend is written in Python and requires a locally installed MySQL database.
We recommend using Conda to create an environment for the backend and easily managing the dependencies. The following will install all of the dependencies required by the backend server:
conda create -n dev python=3.7
conda activate dev
pip install -r requirements.txt
Next, follow these instructions to install MySQL.
Set up your SSL certificates, e.g.:
mkdir ~/.ssl
cd ~/.ssl
openssl req -newkey rsa:2048 -x509 -new -nodes -keyout local-cert.key -out local-cert.crt -subj /CN=test1 -sha256 -days 365 -addext "extendedKeyUsage = serverAuth"
cat local-cert.key local-cert.crt > local-cert.pem
chmod 600 *
ln -s local-cert.key dynabench.org-key.pem
ln -s local-cert.crt dynabench.org.crt
Run the installation script to create your configuration files and ensure all outstanding database migrations are marked as completed:
cd api
python install.py
The script will ask you a list of questions to fill in the config file (in api/common/config.py). The answers will look like as follows:
Please enter your db_name: dynabench
Please enter your db_user: dynabench
Please enter your db_password: {use the password you set in MySQL install instructions}
Please enter your ssl_cert_file_path: {home directory path}/.ssl/dynabench.org.crt
Please enter your ssl_org_pem_file_path: {home directory path}/.ssl/dynabench.org-key.pem
Run the server:
cd api
python server.py dev
Your API backend should now be running at https://localhost:8081. If you just generated a local and unverified certificate, you may need to tell your browser it's okay to proceed.
To install and run the frontend, we recommend using nvm (see here for installation instructions) to manage and install node versions.
cd frontends/web/
nvm install node
nvm install-latest-npm
npm install
echo 'REACT_APP_API_HOST = "https://localhost:8081"' >> .env
npm start
If you get a warning about SSL certificates, edit the corresponding paths in package.json. Your frontend should now be running at https://localhost:3000.
Alternatively, you can run the following two commands to setup both backend and frontend locally:
docker-compose build --no-cache
docker-compose up
Backend will be running on localhost:8081 and Frontend will be running on localhost:3000.