Dev's Guide: Running from source

This page explains how to run Judgels locally from source.

• Prerequisites
• Running the server app
• Importing sample data
• Running the client app
• Troubleshooting

Prerequisites

• Java 17 JDK
• MySQL 8
• Node 20
• Yarn 1.3+

Running the server app

1. Go to judgels-backends/judgels-server-app.
2. Copy the example config file:

   cp var/conf/judgels-server.yml.example var/conf/judgels-server.yml
   

3. Create a new local MySQL database called judgels.
4. Open the config file var/conf/judgels-server.yml.
5. Under database:, modify user and password as necessary so that we can connect to the judgels database.
6. Run database migration:

   ../gradlew dbMigrate
   

7. Verify that there are new tables generated in the database.
8. Finally, run the server app:

   ../gradlew run
   

9. Verify that we can open the server admin app at http://localhost:9101.
10. Verify that we can log in as the default superadmin user (username: superadmin, password: superadmin).

Importing sample data

1. Import the sample SQL data from seeds/judgels.sql to the judgels database.
2. Still in judgels-backends/judgels-server-app, untar the *.tar.gz files from seeds/ to var/data:

   mkdir -p var/data
   tar -xf ../../seeds/problems.tar.gz -C var/data/
   tar -xf ../../seeds/lessons.tar.gz -C var/data/
   tar -xf ../../seeds/submissions.tar.gz -C var/data/
   

The seed data contains:

• 6 users with the following usernames: andi, budi, caca, dudi, emir, fuad. Passwords are equal to the usernames.
• Sample problems, lessons, and submissions data.

Running the client app

1. Go to judgels-client.
2. Copy the example config:

   cp public/var/conf/judgels-client.js.example public/var/conf/judgels-client.js
   

3. (Optional) If you are developing for TLX, open the config file (public/var/conf/judgels-client.js) and change window.conf.mode to TLX.
4. Install client app dependencies:

   yarn install
   

5. Finally, run the client app:

   yarn start
   

6. Verify that we can open the client app at http://localhost:3000.

Congratulations, you have successfully run Judgels from source!

Troubleshooting

• Error: EMFILE: too many open files, watch on macOS when running yarn test
  • To fix this, run:

    brew install watchman
    

    See https://github.com/facebook/create-react-app/issues/4540 for more details.