Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.72 KB

File metadata and controls

62 lines (46 loc) · 2.72 KB

Welcome to Starter Kit Mongo Realm 👋

Version License: ISC

A starter kit for start with Mongo Realm

Before Install

nvm use

Install

npm ci

Before commit and push

npm run build

Before Getting Started

  • Click on the button Use Template in MONGODB-REALM-TYPESCRIPT-EXAMPLE and clone your fresh repository : Use Template
  • Go to your app service in the menu Manage > Deployment and Tab Configuration : Deployment Configuration Tab
  • Follow the 4 steps : Install App Services on your GitHub, Authorize App Services Github App, Select your repository and enable Automatic Deployment

Getting Started

You need to modify some value in different files :

  • Change line 5 ("clusterName": "<Name-Of-Your-Cluster>") in data_sources/mongodb-atlas/config.json. Adding the name of your cluster in Mongo Atlas. The name of your cluster is next to the button Connect : Name of Cluster
  • Change line 2 ("app_id": "<app-id>") in realm_config.json. Adding the ID of your application in App Services. You can copy the ID from your dashboard App Services : App ID
  • Change line 4 ("name": "<name-of-application>") in realm_config.json. Adding the name of your application in App Services. You can found the name of your application from your dashboard (in my case is Application-0) : App ID
  • Change line 6 ("provider_region": "<provider-region>") in realm_config.json. Adding your region where you have to deploy your App Service . You can found your region from the menu App Settings (in my case is Ireland (eu-west-1) • AWS, which give aws-eu-west-1 ) : Deployment Region
  • Commit and push your changement and after the deploy finish in App Service. You can see a new endpoint and a function example appear.

Author

👤 Gaëtan Cottrez [email protected]

Show your support

Give a ⭐️ if this project helped you!

GaetanCottrez