UI for Azure Cosmos DB. Powers the Azure Portal, https://cosmos.azure.com/, and the Cosmos DB Emulator (Mirror of https://github.com/Azure/cosmos-explorer)
Go to file
Steve Faulkner 1f4074f3e8
Update Coding Guidelines (#441)
Co-authored-by: Christopher Anderson <anderson.chris.john@gmail.com>
2021-02-18 13:18:50 -06:00
.github Test explorer changes (#420) 2021-02-08 09:42:16 -08:00
.vs Cost Estimate Changes (#342) 2020-12-18 16:15:55 -08:00
.vscode Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
__mocks__ Clean up unused utility functions for creating databases and collections (#181) 2020-09-03 13:05:22 -07:00
canvas Remove dependency on canvas (#354) 2020-12-26 21:56:37 -06:00
configs Enable gallery publishing in MPAC (#416) 2021-02-03 23:42:11 +05:30
externals Migrated Hosted Explorer to React (#360) 2021-01-19 16:31:55 -06:00
fonts/segoe-ui/west-european/normal Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
images More gallery updates (#418) 2021-02-03 23:24:27 +05:30
less Move delete collection confirmation pane to react (#417) 2021-02-10 13:44:00 -08:00
quickstart Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
sampleData Remove RUPM (#328) 2020-12-01 07:06:38 +00:00
src mongo index editor for AAD login + hostedExplorer (#438) 2021-02-17 12:52:47 -08:00
strict-migration-tools Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
test End to end testcase for mongoDb index policy (#426) 2021-02-18 05:40:58 -08:00
utils Fix applyExplorerBindings call in Portal (#408) 2021-01-27 20:37:14 -06:00
.env.example End to end testcase for mongoDb index policy (#426) 2021-02-18 05:40:58 -08:00
.eslintignore Move delete collection confirmation pane to react (#417) 2021-02-10 13:44:00 -08:00
.eslintrc.js Prettier 2.0 (#393) 2021-01-20 09:15:01 -06:00
.gitignore Use Puppeteer for Emulator Test (#321) 2020-11-13 10:58:38 -06:00
.npmrc Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
CODING_GUIDELINES.md Update Coding Guidelines (#441) 2021-02-18 13:18:50 -06:00
CONTRIBUTING.md Update Coding Guidelines (#441) 2021-02-18 13:18:50 -06:00
DataExplorer.nuspec Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
LICENSE Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
README.md Add Architecture Diagram to README (#380) 2021-01-08 22:20:40 -06:00
ReleaseNotes.md Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
azure-pipelines.cg.yml Update azure-pipelines.cg.yml for Azure Pipelines 2020-10-15 16:20:38 -05:00
babel.config.js Prettier 2.0 (#393) 2021-01-20 09:15:01 -06:00
copyToConsumers.js Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
jest-puppeteer.config.js Prettier 2.0 (#393) 2021-01-20 09:15:01 -06:00
jest.config.e2e.js Prettier 2.0 (#393) 2021-01-20 09:15:01 -06:00
jest.config.js Prettier 2.0 (#393) 2021-01-20 09:15:01 -06:00
mockModule.js Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
package-lock.json Added localization for the Self Serve Model (#406) 2021-01-28 11:17:02 -08:00
package.json Added localization for the Self Serve Model (#406) 2021-01-28 11:17:02 -08:00
tsconfig.contracts.json Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
tsconfig.json Added the Self Serve Data Model (#367) 2021-01-19 22:42:45 -08:00
tsconfig.strict.json Migrated Hosted Explorer to React (#360) 2021-01-19 16:31:55 -06:00
tsconfig.test.json Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
tslint.json Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
web.config Disable caching for config.json file (#421) 2021-02-04 15:25:13 +05:30
webpack.config.js Prettier 2.0 (#393) 2021-01-20 09:15:01 -06:00

README.md

Cosmos DB Explorer

UI for Azure Cosmos DB. Powers the Azure Portal, https://cosmos.azure.com/, and the Cosmos DB Emulator

Getting Started

  • npm install
  • npm run build

Developing

Watch mode

Run npm start to start the development server and automatically rebuild on changes

Hosted Development (https://cosmos.azure.com)

  • Visit: https://localhost:1234/hostedExplorer.html
  • Local sign in via AAD will NOT work. Connection string only in dev mode. Use the Portal if you need AAD auth.
  • The default webpack dev server configuration will proxy requests to the production portal backend: https://main.documentdb.ext.azure.com. This will allow you to use production connection strings on your local machine.

Emulator Development

Setting up a Remote Emulator

The Cosmos emulator currently only runs in Windows environments. You can still develop on a non-Windows machine by setting up an emulator on a windows box and exposing its ports publicly:

  1. Expose these ports publicly: 8081, 8900, 8979, 10250, 10251, 10252, 10253, 10254, 10255, 10256

  2. Download and install the emulator: https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator

  3. Start the emulator from PowerShell:

> cd C:/

> .\CosmosDB.Emulator.exe -AllowNetworkAccess -Key="<EMULATOR MASTER KEY>"

Portal Development

Testing

Unit Tests

Unit tests are located adjacent to the code under test and run with Jest:

npm run test

End to End CI Tests

Jest and Puppeteer are used for end to end browser based tests and are contained in test/. To run these tests locally:

  1. Copy .env.example to .env
  2. Update the values in .env including your local data explorer endpoint (ask a teammate/codeowner for help with .env values)
  3. Make sure all packages are installed npm install
  4. Run the server npm run start and wait for it to start
  5. Run npm run test:e2e

Releasing

We generally adhere to the release strategy documented by the Azure SDK Guidelines. Most releases should happen from the master branch. If master contains commits that cannot be released, you may create a release from a release/ or hotfix/ branch. See linked documentation for more details.

Architechture

Contributing

Please read the contribution guidelines.