Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 1.77 KB

DEVELOPER_ONBOARDING.md

File metadata and controls

50 lines (30 loc) · 1.77 KB
Raw

Developer Onboarding

Want to contribute to Highlight? Here's your getting started guide to developing on Highlight.

Prerequisites

  • git (2.13+)

  • Docker Desktop (19.03.0+) with the following resources (Docker icon -> Preferences -> Resources)

    • CPUs: 4
    • Memory: 16 GB
    • Virtual disk limit: 256 GB

Screenshot 2023-03-20 at 9 21 31 AM

Installation

git clone --recurse-submodules https://github.com/highlight/highlight
cd highlight/docker
docker compose -f compose.yml -f compose.dev.yml up --build -d

After all services are built and running, you can visit https://localhost:3000 to view the dashboard and go through the login flow (there are no credentials).

Debugging

Frontend

We recommend using the Chrome DevTools if you need a debugger.

  • Open the Developer Tools (View -> Developer -> Developer Tools)
  • Click the Sources tab
  • ⌘ + P and search for the filename to set a breakpoint

Kapture 2023-03-20 at 09 09 36

Check out the Chrome DevTools guides for additional debugging information.

Backend

We recommend using VSCode if you need a debugger.

  • Run -> Start Debugging
  • Drop a breakpoint somewhere

Kapture 2023-03-20 at 09 33 17

Learn more about debugging with VSCode through their docs.