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
Jordi Bunster 5cd4e93c65
Fix preview URL branch display, include link in new PRs (#644)
* Make it easy to include preview links

* Fix display of currently previewed branch
2021-04-12 15:07:37 -07:00
.github Fix preview URL branch display, include link in new PRs (#644) 2021-04-12 15:07:37 -07:00
.vs Cost Estimate Changes (#342) 2020-12-18 16:15:55 -08:00
.vscode Configure onsave auto format eslint in vscode (#478) 2021-03-09 19:31:38 -06: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 removed enableGalleryPublish, enableLinkInjection feature flags (#454) 2021-02-26 13:07:44 -08:00
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 Knockout tab changes 2021-03-22 10:13:44 -07:00
preview Pull request preview URLs (#625) 2021-04-12 15:10:31 -05:00
quickstart Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
sampleData Fix start with samples in Gremlin API (#448) 2021-02-24 12:17:15 -06:00
src Fix preview URL branch display, include link in new PRs (#644) 2021-04-12 15:07:37 -07:00
strict-null-checks Switch to accessibility insights's version of these tools (#603) 2021-04-12 15:12:19 -05:00
test Migration/delete database confirmation in react (#542) 2021-03-31 17:44:07 -05:00
utils Bump node-fetch from 2.6.0 to 2.6.1 in /utils/deployment-status (#587) 2021-03-29 21:22:31 -05:00
.env.example End to end testcase for mongoDb index policy (#426) 2021-02-18 05:40:58 -08:00
.eslintignore Remove unused table-column-options-panel (#620) 2021-04-06 09:43:15 -05:00
.eslintrc.js Warn on React hook misuse (#632) 2021-04-12 15:13:17 -05: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 Update README.md 2021-03-27 11:18:59 -07: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 Update Puppeteer (#562) 2021-03-18 17:53:15 -05:00
jest.config.e2e.js Prettier 2.0 (#393) 2021-01-20 09:15:01 -06:00
jest.config.js Knockout tab changes 2021-03-22 10:13:44 -07:00
mockModule.js Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
package-lock.json Add second App Insights instance (#609) 2021-04-05 18:03:17 -05:00
package.json Switch to accessibility insights's version of these tools (#603) 2021-04-12 15:12:19 -05:00
tsconfig.contracts.json Created selfServe landing page (#444) 2021-03-10 13:55:05 -08:00
tsconfig.json Drop IE11 Support (#476) 2021-03-29 13:31:52 -05:00
tsconfig.strict.json Switch to accessibility insights's version of these tools (#603) 2021-04-12 15:12:19 -05: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 Made webpack changes (#629) 2021-04-07 16:10:26 -07: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
  • 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.

Architecture

Contributing

Please read the contribution guidelines.