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
Asier Isayas 6aeac542b1
Runtime Proxy API (#1950)
Co-authored-by: Asier Isayas <aisayas@microsoft.com>
2024-08-28 09:04:49 -04:00
.github Update Playwright, improve E2E test reliability, add scripts to deploy test resources (#1857) 2024-06-05 12:46:32 -07:00
.vs Cost Estimate Changes (#342) 2020-12-18 16:15:55 -08:00
.vscode Improve error handling when acquiring aad tokens (#1746) 2024-03-04 16:08:13 -08:00
__mocks__ Clean up unused utility functions for creating databases and collections (#181) 2020-09-03 13:05:22 -07:00
configs add feedback policies integration with copilot (#1745) 2024-03-06 10:33:21 -06:00
docs Text changes for API rebranding (#1330) 2022-10-05 17:35:03 -07:00
externals Add CellOutputViewer for SandboxOutputs (#686) 2021-04-22 13:37:12 -04:00
fonts/segoe-ui/west-european/normal Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
images Add Data Plane RBAC functionality (#1878) 2024-07-01 09:33:07 -07:00
jest Upgrade typescript to 4.9.5 and jest to 29.7.0 (and related packages) (#1884) 2024-07-30 15:41:41 -07:00
less fix #1929 by using flex instead of grid to lay out the tabs view (#1930) 2024-08-13 11:19:24 -07:00
patches Redesign resource tree (#1865) 2024-08-01 10:02:36 -07:00
preview Update subscription for preview PRs (#1265) 2022-05-04 20:11:13 -07:00
quickstart Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
sampleData integrate copilot UI with backend (#1478) 2023-06-16 00:25:23 -07:00
src Runtime Proxy API (#1950) 2024-08-28 09:04:49 -04:00
strict-null-checks Switch to accessibility insights's version of these tools (#603) 2021-04-12 15:12:19 -05:00
test disable query error tests due to backend issue (#1942) 2024-08-21 11:30:43 -07:00
utils Use new Fluent-based Resource Tree for all environments (#1841) 2024-05-29 09:56:27 -07:00
.editorconfig Update Playwright, improve E2E test reliability, add scripts to deploy test resources (#1857) 2024-06-05 12:46:32 -07:00
.env.example Migrate resource tree to react (#941) 2021-07-20 11:40:04 -07:00
.eslintignore Update Playwright, improve E2E test reliability, add scripts to deploy test resources (#1857) 2024-06-05 12:46:32 -07:00
.eslintrc.js Make Data Explorer work on node v18 (#1654) 2023-12-13 10:24:40 -08:00
.gitignore Update Playwright, improve E2E test reliability, add scripts to deploy test resources (#1857) 2024-06-05 12:46:32 -07:00
.npmrc Redesign resource tree (#1865) 2024-08-01 10:02:36 -07:00
CODING_GUIDELINES.md Remove IE11 from Coding Guidelines 2021-05-07 10:04:47 -05: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
SECURITY.md Microsoft mandatory file (#1276) 2023-06-08 18:32:42 -07: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.config.js Error rendering improvements (#1887) 2024-08-15 13:29:57 -07:00
mockModule.js Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
package-lock.json Error rendering improvements (#1887) 2024-08-15 13:29:57 -07:00
package.json Redesign resource tree (#1865) 2024-08-01 10:02:36 -07:00
playwright.config.ts Error rendering improvements (#1887) 2024-08-15 13:29:57 -07:00
tsconfig.contracts.json Created selfServe landing page (#444) 2021-03-10 13:55:05 -08:00
tsconfig.json Update throughput settings tab with new elasticity properties (#1461) 2023-06-16 15:54:29 -07:00
tsconfig.strict.json Redesign resource tree (#1865) 2024-08-01 10:02:36 -07:00
tsconfig.test.json eslint switch/case exhaustiveness check rule (#739) 2021-05-04 09:12:54 -07:00
web.config Legacy Mongo Shell Mongo Proxy support (#1802) 2024-04-17 19:01:12 -04:00
webpack.config.js Upgrade typescript to 4.9.5 and jest to 29.7.0 (and related packages) (#1884) 2024-07-30 15:41:41 -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.