Skip to content

Commit 795d3a1

Browse files
authored
Merge pull request #476 from OpenBeta/readme/#348
Add some more detail on installing mongodb just a readme touchup so we can clear out old issues
2 parents a48ad19 + 18a3d27 commit 795d3a1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Build](https://gitlab.com/openbeta/openbeta-graphql/badges/develop/pipeline.svg)](https://gitlab.com/openbeta/openbeta-graphql/-/pipelines) [![License](https://img.shields.io/github/license/openbeta/openbeta-graphql?style=flat-square)](./LICENSE)
1+
c[![Build](https://gitlab.com/openbeta/openbeta-graphql/badges/develop/pipeline.svg)](https://gitlab.com/openbeta/openbeta-graphql/-/pipelines) [![License](https://img.shields.io/github/license/openbeta/openbeta-graphql?style=flat-square)](./LICENSE)
22
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
33
[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat-square)](#contributors-)
44
<!-- ALL-CONTRIBUTORS-BADGE:END -->
@@ -65,6 +65,12 @@ query Example1 {
6565
```
6666

6767
### Development
68+
#### Installing mongodb
69+
70+
This step often trips up new devs. the install for most database engines can be little bit hairy, but mongodb is made a particular challenge by its lack of wide availability in common package managers. If you have docker installed, then your easiest bet is definitely to just do `docker compose up` when you need the persistent database. If that doesn't seem like fun to you, your next option is to get a binary [from their page directly](https://www.mongodb.com/try/download/community) they have wide platform support and you shouldn't have an issue finding one that will run for you.
71+
72+
When configuring it for development, it should be fine to leave auth disabled, since the data inside is not sensitive.
73+
6874
#### Requirements
6975

7076
- [Docker](https://docs.docker.com/get-docker)

0 commit comments

Comments
 (0)