### Install and Start Compass

Source: https://github.com/mongodb-js/compass/blob/main/packages/compass/README.md

Installs project dependencies and starts Compass. Supports different distribution modes.

```shell
npm install
npm start [compass|compass-readonly|compass-isolated]
```

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

### Windows Startup Log Example

Source: https://github.com/mongodb-js/compass/blob/main/packages/hadron-build/README.md

This log snippet shows the process of starting the Squirrel Updater for an application on Windows, including the paths for the executable and its working directory.

```log
2016-06-24 12:32:51> Program: Starting Squirrel Updater: --processStart ${_.titlecase(productName)}.exe
2016-06-24 12:32:51> Program: Want to launch 'C:\Users\${username}\AppData\Local\${_.titlecase(productName)}\app-${version}\${_.titlecase(productName)}.exe':
2016-06-24 12:32:51> Program: About to launch: 'C:\Users\${username}\AppData\Local\${_.titlecase(productName)}\app-${version}\${_.titlecase(productName)}.exe':
```

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

### Installation

Source: https://github.com/mongodb-js/compass/blob/main/packages/instance-model/README.md

Install the mongodb-instance-model package using npm.

```bash
npm install --save mongodb-instance-model
```

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

### Install compass-preferences-model

Source: https://github.com/mongodb-js/compass/blob/main/packages/compass-preferences-model/README.md

Install the compass-preferences-model package using npm.

```bash
npm install --save compass-preferences-model
```

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

### Install Hadron Document

Source: https://github.com/mongodb-js/compass/blob/main/packages/hadron-document/README.md

Install the hadron-document package using npm.

```bash
npm install --save hadron-document
```

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

### Install Hadron-Build

Source: https://github.com/mongodb-js/compass/blob/main/packages/hadron-build/README.md

Install hadron-build as a development dependency using npm.

```bash
npm install --save-dev hadron-build;
```

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

### Install bson-transpilers

Source: https://github.com/mongodb-js/compass/blob/main/packages/bson-transpilers/README.md

Install the bson-transpilers package using npm.

```shell
npm install -S bson-transpilers
```

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

### Start Electron Development Server

Source: https://github.com/mongodb-js/compass/blob/main/packages/compass-aggregations/README.md

Command to start the Electron development server for Compass.

```shell
npm start
```

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

### Install Java with Homebrew

Source: https://github.com/mongodb-js/compass/blob/main/packages/bson-transpilers/CONTRIBUTING.md

Use Homebrew to install Java, a prerequisite for ANTLR4.

```shell
$ brew cask install java
```

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

### Successful Squirrel.Windows Installation Log Entries

Source: https://github.com/mongodb-js/compass/blob/main/packages/hadron-build/README.md

These log entries indicate a successful start to the Squirrel.Windows update process, including program initiation and temporary directory setup.

```log
2016-06-24 09:46:12> Program: Starting Squirrel Updater: --install .
2016-06-24 09:46:12> Program: Starting install, writing to C:\Users\${username}\AppData\Local\SquirrelTemp
2016-06-24 09:46:12> Program: About to install to: C:\Users\${username}\AppData\Local\${_.titlecase(productName)}
```

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

### Start Electron Development Server

Source: https://github.com/mongodb-js/compass/blob/main/packages/compass-serverstats/README.md

Run 'npm start' to launch an Electron window for developing and testing the component. This command automatically compiles the source and reloads the window on file changes.

```bash
npm start

```

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

### Browser Package Mocha Config

Source: https://github.com/mongodb-js/compass/blob/main/configs/mocha-config-compass/README.md

Extend the general-purpose configuration for browser-targeted packages. This setup includes jsdom in the environment and registers chai-dom helpers. Ensure @types/chai-dom is installed if needed.

```javascript
// file:<package>/.mocharc.js
module.exports = require('@mongodb-js/mocha-config-compass/react');
```

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

### Copy Sample Template File

Source: https://github.com/mongodb-js/compass/blob/main/packages/bson-transpilers/CONTRIBUTING.md

Copy the sample template file to your new output language directory. This file serves as a starting point for your language's templates.

```shell
cp symbols/sample_template.yaml symbols/<output lang>/templates.yaml
```

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

### Install reflux-state-mixin

Source: https://github.com/mongodb-js/compass/blob/main/packages/reflux-state-mixin/README.md

Install the mixin using npm.

```bash
$ npm install @mongodb-js/reflux-state-mixin --save
```

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

### Install mongodb-database-model

Source: https://github.com/mongodb-js/compass/blob/main/packages/database-model/README.md

Install the package using npm.

```bash
npm install --save mongodb-database-model
```

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

### Install mongodb-collection-model

Source: https://github.com/mongodb-js/compass/blob/main/packages/collection-model/README.md

Install the package using npm.

```bash
npm install --save mongodb-collection-model
```

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

### Install mongodb-data-service

Source: https://github.com/mongodb-js/compass/blob/main/packages/data-service/README.md

Install the mongodb-data-service package using npm.

```bash
npm install --save mongodb-data-service
```

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

### Configure Query Bar Store and Actions in Hadron/Electron

Source: https://github.com/mongodb-js/compass/blob/main/packages/compass-query-bar/README.md

Set up the Query Bar component for Hadron/Electron environments by configuring its store and actions. Requires `appRegistry` and `localAppRegistry`.

```javascript
const role = appRegistry.getRole('Query.QueryBar')[0];
const Plugin = role.component;
const configureStore = role.configureStore;
const configureActions = role.configureActions;

const actions = configureActions();
const store = configureStore({
  globalAppRegistry: appRegistry,
  localAppRegistry: localAppRegistry,
  actions: actions,
  namespace: 'db.coll',
  serverVersion: '4.2.0',
  fields: [],
});

<Plugin store={store} actions={actions} />;
```

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

### Example Usage Placeholder

Source: https://github.com/mongodb-js/compass/blob/main/packages/compass-preferences-model/README.md

This is a placeholder for example usage. The actual implementation details are not provided in this section.

```javascript
// @todo
```