Skip to content

Repository files navigation

comma connect

The web and mobile companion application for openpilot

Try it with your openpilot device:

Development

  • Install bun: https://bun.sh/docs/installation
  • Install dependencies: bun install
  • Start dev server: bun start
  • Demo mode: Navigate to /demo to test locally without a comma device.

API and useradmin URL roots can be overridden at build time with VITE_COMMA_URL_ROOT, VITE_ATHENA_URL_ROOT, VITE_BILLING_URL_ROOT, and VITE_USERADMIN_URL_ROOT. Docker Compose accepts the same variables.

Contributing

  • Use best practices
  • Write test cases
  • Keep files small and clean
  • Use branches / pull requests to isolate work. Don't do work that can't be merged quickly, find ways to break it up

Libraries Used

There's a ton of them, but these are worth mentioning because they sort of affect everything.

  • React - Object oriented components with basic lifecycle callbacks rendered by state and prop changes.
  • Redux - Sane formal global scope. This is not a replacement for component state, which is the best way to store local component level variables and trigger re-renders. Redux state is for global state that many unrelated components care about. No free-form editing, only specific pre-defined actions. Redux DevTools can be very helpful.
  • @material-ui - Lots of fully featured highly customizable components for building the UIs with. Theming system with global and per-component overrides of any CSS values.
  • connected-react-router - Mindlessly simple routing with convenient global access due to redux

About

manage your openpilot experience

Resources

Stars

137 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages