Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (49 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

73 lines (49 loc) · 1.07 KB

Contribution Guide

GitRec is a website composed of multiple components. This guide will introduce how to setup a develop environment quickly.

Setup Develop Environment

  1. Deploy GitRec via Docker Compose.
  2. Install just a command runner.
  3. Install Python dependencies:
 pip install -r requirements.txt
  1. Install npm and yarn:
# Install npm
sudo apt-get install npm

# Install yarn
sudo npm i -g yarn

Develop Guide

These following command should be executed in the root directory of GitRec source.

CronJobs

just debug-cronjobs

GITHUB_ACCESS_TOKEN will be loaded from .env automatically.

Jobs

just debug-jobs

Web Backend

  1. Build the frontend:
cd frontend
yarn install
yarn build
  1. Start web service in debug mode:
just debug-web

Web Frontend

  1. Start web backend:
just debug-backend
  1. Start web frontend:
cd frontend
yarn install
yarn serve --port 5000