Skip to content

Commit d2d94aa

Browse files
authored
Merge pull request #3976 from kunstewi/installation-mongo
docs: added a new section in installation.md to get the mongodb connection string from cloud.mongodb.com
2 parents bfe708c + 8217837 commit d2d94aa

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

contributor_docs/installation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
3737
7. Install MongoDB and make sure it is running
3838
* For Mac OSX with [homebrew](http://brew.sh/): `brew tap mongodb/brew` then `brew install mongodb-community` and finally start the server with `brew services start mongodb-community` or you can visit the installation guide here [Installation Guide For MacOS](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/)
3939
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
40+
* If you have trouble setting up MongoDB locally, an alternative is to use [MongoDB Atlas](https://cloud.mongodb.com/) to get a connection string that you can use as your `MONGO_URL` in the `.env` file. To get your connection string:
41+
- Navigate to [mongodb.com](https://www.mongodb.com/) and sign up or log in.
42+
- Create a new project. Give it any name, and either add a key-value pair or skip that step.
43+
- Create a cluster by choosing the free tier. Give your cluster a name, choose a region, and keep the provider as AWS.
44+
- Set a username and password for your database-user, these will be part of your connection string.
45+
- Choose **Node.js** as the driver for your connection method. You will see a connection string, with or without the password filled in.
46+
- Copy the string and use it as your `MONGO_URL` in the `.env` file.
4047
8. `$ cp .env.example .env`
4148
9. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
4249
* See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github.

0 commit comments

Comments
 (0)