MongoDB Compass Monorepo

This repository contains the source code and build tooling used in MongoDB Compass.

Packages Overview

• mongodb-compass: MongoDB Compass Application

Compass Plugins

• @mongodb-js/compass-aggregations: Compass Aggregation Pipeline Builder
• @mongodb-js/compass-app-stores: The external stores repo for compass
• @mongodb-js/compass-auto-updates: Compass Auto Updates Plugin
• @mongodb-js/compass-collection: Compass Collection Plugin
• @mongodb-js/compass-connections: Connection Screen
• @mongodb-js/compass-crud: Compass Plugin for CRUD Operations
• @mongodb-js/compass-database: Compass Database Plugin
• @mongodb-js/compass-databases-collections: Plugin for viewing the list of, creating, and dropping databases and collections
• @mongodb-js/compass-deployment-awareness: Compass Deployment Awareness Plugin
• @mongodb-js/compass-explain-plan: Evaluate the performance of your quer
• @mongodb-js/compass-export-to-language: export to language modal
• @mongodb-js/compass-field-store: FieldStore keeps track of available fields in a collection.
• @mongodb-js/compass-find-in-page: cmd-f UI for compass
• @mongodb-js/compass-home: Home
• @mongodb-js/compass-import-export: Compass Import/Export Plugin
• @mongodb-js/compass-indexes: Indexes support for Compass
• @mongodb-js/compass-instance: compass instance plugin
• @mongodb-js/compass-loading: Compass Loading Screen
• @mongodb-js/compass-plugin-info: Compass Plugin Information Plugin
• @mongodb-js/compass-query-bar: Renders a component for executing MongoDB queries through a GUI.
• @mongodb-js/compass-query-history: The query history sidebar.
• @mongodb-js/compass-schema: Compass Schema Tab Plugin
• @mongodb-js/compass-schema-validation: Compass plugin for document JSON schema validation
• @mongodb-js/compass-server-version: Compass Server Version
• @mongodb-js/compass-serverstats: Compass Real Time Server Stats Component.
• @mongodb-js/compass-shell: Compass Shell Plugin
• @mongodb-js/compass-sidebar: Sidebar external plugin
• @mongodb-js/compass-ssh-tunnel-status: Compass SSH Tunnel Status
• @mongodb-js/compass-status: Compass Status Plugin

Shared Libraries and Build Tools

• @mongodb-js/compass-components: A set of React Components used in Compass
• @mongodb-js/connection-form: A form for specifying information needed to connect to a MongoDB instance
• @mongodb-js/hadron-plugin-manager: Hadron Plugin Manager
• @mongodb-js/mongodb-notary-service-client: A client for our notary-service: an API for codesigning.
• @mongodb-js/mongodb-redux-common: Common Redux Modules for mongodb-js
• app-migrations: Helper for application schema migrations.
• compass-preferences-model: Compass preferences model.
• compass-user-model: MongoDB user model.
• electron-license: Tools for electron apps to work with licenses
• hadron-app: Hadron Application Singleton
• hadron-app-registry: Hadron App Registry
• hadron-auto-update-manager: Atoms AutoUpdateManager class as a standalone module.
• hadron-build: Tooling for Hadron apps.
• hadron-document: Hadron Document
• hadron-ipc: Simplified IPC for electron apps.
• hadron-react-bson: Hadron React BSON Components
• hadron-react-buttons: Hadron React Button Components
• hadron-react-components: Hadron React Components
• hadron-reflux-store: Hadron Reflux Stores
• hadron-type-checker: Hadron Type Checker
• mongodb-ace-mode: MongoDB Mode for the ACE Editor
• mongodb-collection-model: MongoDB collection model.
• mongodb-connection-model: MongoDB connection model.
• mongodb-data-service: MongoDB Data Service
• mongodb-database-model: MongoDB database model.
• mongodb-explain-compat: Convert mongodb SBE explain output to 4.4 explain output
• mongodb-explain-plan-model: Ampersand model abstraction for MongoDB explain plans (3.0+)
• mongodb-index-model: MongoDB index model.
• mongodb-instance-model: MongoDB instance model.
• storage-mixin: Ampersand model mixin to persist data via various storage backends

Shared Configuration Files

• @mongodb-js/eslint-config-compass: Shared eslint configuration used in Compass packages.
• @mongodb-js/mocha-config-compass: Shared mocha configuration used in Compass packages.
• @mongodb-js/prettier-config-compass: Shared prettier configurations used in Compass packages.
• @mongodb-js/tsconfig-compass: Shared basic TypeScript configurations used in Compass packages.

Contributing

For contributing, please refer to CONTRIBUTING.md

For issues, please create a ticket in our JIRA Project.

Is there anything else you’d like to see in Compass? Let us know by submitting suggestions in out feedback forum.

License

SSPL