Skip to content

Latest commit

 

History

History
132 lines (82 loc) · 3.59 KB

README.md

File metadata and controls

132 lines (82 loc) · 3.59 KB
Raw

Hurado

NOI.PH's online judge

Development

Recommended computer specs

  • RAM: 8GB or more
  • CPU: Intel i3 or better

Getting started

If you're using Windows, we recommend using WSL 2 to emulate a Unix environment. If you haven't yet, set up your own SSH-key and add it to your SSH-agent.

Fork the repository

Fork the Hurado repository with the help of this guide.

Clone your fork of the repository

Before cloning your fork of the repository, make sure that you have added your SSH-key to your SSH-agent. You can clone the repository by running the following command:

git clone [email protected]:your_username/hurado.git

Installing dependencies

Setup NodeJS

We recommend using NodeJS 20 when running this application. Kindly go to this guide to configure which version of NodeJS runs in your environment.

Once NVM has been installed, run the following so that NodeJS v20 is installed:

nvm install 20
nvm use 20

Install the required packages:

npm ci

Manually installing packages is done because this can be slow and humans know when to do this best.

Setup Docker

We use docker containers for supporting services like postgresql. Follow instructions here to get a new version of docker.

Running the server

Set up local environment variables

Go to the repository directory by running the following command:

cd hurado

Copy the local environment:

cp .env.template .env

Run docker compose

On a seperate terminal window, run the containers by running the following command in the project directory:

docker compose up

This will automatically load the environment variables into the containers.

Database setup

These commands will have to be run from within the hurado-dev contaner. Get into the container by running

./scripts/bash

Migrate the database to the latest version:

npm run db:migrate

Seed some initial data:

npm run db:seed

Visiting the local website

Now open your browser and go to http://localhost:10000/

You should also be able to see the debug logs on the terminal window where you ran docker compose up

Congrats! The setup is now done!

Contribution Workflow

  1. Follow the above instructions regarding forking, cloning, and running this repository.
  2. Read the contributor's guide for useful tips to improve your experience
  3. Add and commit your changes to the repository. Don't forget to add your name to the contributors section below.
  4. Submit a pull request (PR) and tag one of the contributors to review your code.
  5. Wait for the review and address the comments.
  6. Wait for the reviewer to approve your PR.
  7. Merge your PR.

Contributors