CONTRIBUTING.md

Contributing

This is a work in progress.

Table of Contents

• Required
• Running Speedtyper.dev
  • Backend
  • Frontend

Required

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

Running Speedtyper.dev

Backend

1. Install dependencies:

   make install-backend-dependencies
   

2. Copy over path of env file:

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

3. Generate Github Access Token (classic) with public_repo permissions and update GITHUB_ACCESS_TOKEN variable in ./packages/back-nest/.env with the token value. It is used to download seed data from GitHub.

4. Start Docker Compose in the background:

   make run-dev-db
   

5. Seed the db with example challenges:

   make run-seed-codesources
   

6. Run the backend:

   make run-backend-dev
   

Frontend

1. Install dependencies:

   make install-webapp-dependencies
   

2. Run the frontend:

   make run-webapp-dev