Hopp

https://docs.gethopp.app/
Admin
Hopp is an open-source remote pair programming app that enables seamless real-time collaboration...
Tokens:2,980
Snippets:45
Trust Score:7.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Start Backend Services

Source: https://docs.gethopp.app/quick-start/local-development/development-workflow

Installs all workspace dependencies, creates SSL certificates, starts Docker containers for PostgreSQL and Redis, and initiates the backend with database initialization. It also includes a task to add mock data for initial testing.

```bash
# Install all workspace dependencies from the root
yarn install


# Create SSL certificates for local development
task backend:create-certs


# Start Docker containers for PostgreSQL and Redis
task backend:compose-up


# Start the backend which inits the database
task backend:dev


# If it is the first time you are running the backend, you need to add mock data to the database.
# By default it adds `michael@dundermifflin.com` and `dwight@dundermifflin.com` users.
task backend:add-mock-data
```

--------------------------------

### Install Pre-commit Hooks

Source: https://docs.gethopp.app/open-source/contribute

Installs pre-commit hooks to ensure code quality and prevent breaking changes in the CI pipeline.

```bash
pre-commit install
```

--------------------------------

### Start Development Server and Tauri App

Source: https://docs.gethopp.app/quick-start/local-development/development-workflow

Starts the backend development server with the local LiveKit server and initiates the Tauri desktop application for development. It also provides commands to generate authentication tokens for specific users.

```bash
# Start the backend which inits the database
task backend:dev

# After the initial setup, **start the backend with the local LiveKit server** : You can change the server’s configuration in the `backend/env-files/.env.local` file.
task dev-server

# Then you can start the Tauri desktop application:
task app:dev

You can get an authentication token with:
task backend:user-token EMAIL=michael@dundermifflin.com

# For debugging purposes, you can spawn a clone of the app:
task app:start-replica-app

And generated a token for `Dwight` user with command:
task backend:user-token EMAIL=dwight@dundermifflin.com
```

--------------------------------

### Cloudflared Configuration for Service Exposure

Source: https://docs.gethopp.app/quick-start/local-development/development-workflow

Example configuration for `cloudflared` to expose the backend API and LiveKit server to the internet. It defines hostnames and the services they should connect to, including a fallback for unhandled requests.

```yaml
tunnel: <tunnel-id>
credentials-file: <path-to-credentials-file>

ingress:
  - hostname: <hostname>
    service: https://localhost:1926


  - hostname: <livekit_hostname>
    service: ws://localhost:7880


  - service: http_status:404
```

--------------------------------

### Initialize Local Development Environment

Source: https://docs.gethopp.app/open-source/contribute

Commands to fork, clone, and navigate to the project repository to begin local development.

```bash
git clone https://github.com/YOUR-USERNAME/hopp.git
cd hopp
```

--------------------------------

### Enable Logging in Tauri App

Source: https://docs.gethopp.app/quick-start/local-development/development-workflow

Demonstrates how to enable logging for the Tauri app by setting the `RUST_LOG` environment variable. This allows for detailed debugging information to be captured during development.

```bash
# For the tauri app you can enable logging by setting the `RUST_LOG` environment variable.
# The values are the same as the ones from env-logger , which is what `hopp_core` is using.
# For example you could run the app with:
RUST_LOG=info task app:dev
```

--------------------------------

### Push Changes and Submit Pull Request

Source: https://docs.gethopp.app/open-source/contribute

Pushes the local feature branch to the remote fork to prepare for a pull request submission.

```bash
git push origin feature/your-feature-name
```

--------------------------------

### Create a New Development Branch

Source: https://docs.gethopp.app/open-source/contribute

Creates a new git branch to isolate changes for a specific feature or bug fix.

```bash
git checkout -b feature/your-feature-name
```
Tokens:
Raw