Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

never let this get slow #9

Merged
merged 5 commits into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ on:
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 1
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v1
Expand Down
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# connect

This is an experimental rewrite of [comma connect](https://github.com/commaai/connect). connect is the web (and mobile) experience for [openpilot](https://github.com/commaai/openpilot).
This is an experimental rewrite of [comma connect](https://github.com/commaai/connect), the web (and mobile) experience for [openpilot](https://github.com/commaai/openpilot).

Try out new-connect at https://new-connect.connect-d5y.pages.dev.

Expand All @@ -12,10 +12,39 @@ Try out new-connect at https://new-connect.connect-d5y.pages.dev.

## Contributing

If you don't have a comma device, connect has a demo mode with some example drives. This should allow for testing most functionality except for interactions with the device, such as getting the car battery voltage.
Join the `#dev-connect-web` channel on our [Discord](https://discord.comma.ai).

- 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
A few constraints:
- 5k line limit
- 500KB bundle size limit
- 1m timeout for all CI; a fast development environment is a delightful one

## Features

These are the minimum features for parity with connect.

Drives
- [ ] list
- [ ] show map
- [ ] play qcams
- [ ] file uploads

Navigation
- [ ] show user and car location
- [ ] send destination to device
- [ ] manage home, work, and favorites

Misc
- [ ] demo mode
- [ ] snapshot
- [ ] comma prime sign up + management
- [ ] pairing to an openpilot device
- [ ] PWA: splash, icon, offline mode, etc.

And some eventual features beyond connect's current feature set:
- [ ] SSH console
- [ ] sentry mode
- [ ] dashcam clips
- [ ] manage openpilot settings
- [ ] replace all of useradmin.comma.ai
- [ ] car mangement: lock doors, EV charge status, etc.