Skip to content

Latest commit

 

History

History
57 lines (47 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

57 lines (47 loc) · 1.58 KB

Contributing

This is a work in progress.

Table of Contents

Required

Prerequisite Link
Git 🔗
Node 20 🔗
Yarn 🔗
PostgreSQL
build-essential (or equivalent for your OS)
Docker (Optional) 🔗

Running Speedtyper.dev

Backend

Install dependencies:

make install-backend-dependencies

Copy over path of env file:

cp ./packages/back-nest/.env.development ./packages/back-nest/.env

Start Docker Compose in the background:

make run-dev-db

Seed the db with example challenges

make run-seed-codesources

Run the backend:

make run-backend-dev

Frontend

Install dependencies:

make install-webapp-dependencies

Run the frontend:

make run-webapp-dev