MongoDB Compass Monorepo

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

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.

Packages Overview

• mongodb-compass: The MongoDB GUI

Compass Plugins

• @mongodb-js/compass-aggregations: Compass Aggregation Pipeline Builder
• @mongodb-js/compass-app-stores: The external stores repo for compass
• @mongodb-js/compass-collection: Compass Collection
• @mongodb-js/compass-crud: Compass Plugin for CRUD Operations
• @mongodb-js/compass-database: Compass Database Plugin
• @mongodb-js/compass-databases-collections: View the list of, create, and drop databases and collections
• @mongodb-js/compass-explain-plan: Evaluate the performance of your query
• @mongodb-js/compass-export-to-language: Export MongoDB queries and aggregations to various languages
• @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: Import/Export feature for Compass
• @mongodb-js/compass-indexes: Collection index management for Compass
• @mongodb-js/compass-instance: Compass instance plugin
• @mongodb-js/compass-query-bar: Renders a component for executing MongoDB queries through a GUI
• @mongodb-js/compass-query-history: Load and manage saved queries in Compass
• @mongodb-js/compass-saved-aggregations-queries: Instance tab plugin that shows saved queries and aggregations
• @mongodb-js/compass-schema: Compass Schema Tab Plugin
• @mongodb-js/compass-schema-validation: Compass plugin for document JSON schema validation
• @mongodb-js/compass-serverstats: Compass Real Time
• @mongodb-js/compass-shell: Compass Shell Plugin
• @mongodb-js/compass-sidebar: The sidebar of Compass

Shared Libraries and Build Tools

• @mongodb-js/compass-components: React Components used in Compass
• @mongodb-js/compass-connection-import-export: UI for Compass connection import/export
• @mongodb-js/compass-connections: Manage your MongoDB connections and connect in Compass
• @mongodb-js/compass-databases-navigation: Databases and collections sidebar navigation tree
• @mongodb-js/compass-editor: Reusable Compass editor component based on ace-editor with MongoDB-specific ace modes, themes, and autocompleters
• @mongodb-js/compass-logging: Shared helpers for logging in Compass packages
• @mongodb-js/compass-maybe-protect-connection-string: Utility for protecting connection strings if requested
• @mongodb-js/compass-settings: Settings for compass
• @mongodb-js/compass-utils: Utilities for MongoDB Compass Development
• @mongodb-js/compass-welcome: The welcome modal
• @mongodb-js/connection-form: A form for specifying information needed to connect to a MongoDB instance
• @mongodb-js/databases-collections-list: List view for the databases and collections
• @mongodb-js/explain-plan-helper: Explain plan utility methods for MongoDB Compass
• @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
• @mongodb-js/ssh-tunnel: Yet another ssh tunnel based on ssh2
• app-migrations: Helper for application schema migrations
• bson-transpilers: Source to source compilers using ANTLR
• compass-e2e-tests: E2E test suite for Compass app that follows smoke tests / feature testing matrix
• 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-build: Tooling for Hadron apps
• hadron-document: Hadron Document
• hadron-ipc: Simplified IPC for electron apps.
• hadron-reflux-store: Hadron Reflux Stores
• hadron-type-checker: Hadron Type Checker
• 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-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 Compass eslint configuration
• @mongodb-js/eslint-plugin-compass: Custom eslint rules for Compass monorepo
• @mongodb-js/mocha-config-compass: Shared mocha mocha configuration for Compass packages
• @mongodb-js/prettier-config-compass: Shared Compass prettier configuration
• @mongodb-js/tsconfig-compass: Shared Compass Typescript configuration
• @mongodb-js/webpack-config-compass: Shared webpack configuration for Compass application and plugins

License

SSPL