You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This package allows using the [MongoDB](https://www.mongodb.com/) database engine with [Sapling](https://github.com/saplingjs/sapling/).
4
+
5
+
6
+
## Installation
7
+
8
+
### Via the CLI (recommended)
9
+
10
+
This package can be installed via the [Sapling CLI](https://saplingjs.com/docs/#/cli) via the project creation questionnaire;
11
+
12
+
sapling create
13
+
14
+
Or added to an existing project by re-running the questionnaire;
15
+
16
+
sapling edit
17
+
18
+
19
+
### Manually
20
+
21
+
Alternatively, if you prefer to install it manually, you can install it via npm;
22
+
23
+
npm install --save @sapling/db-driver-mongodb
24
+
25
+
Then, modify your `config.json` to select the MongoDB driver;
26
+
27
+
{
28
+
"db": {
29
+
"driver": "MongoDB"
30
+
}
31
+
}
32
+
33
+
34
+
## Usage
35
+
36
+
Once installed, Sapling will use MongoDB running on `localhost` on port `27017` to persist all data.
37
+
38
+
You can provide alternative host and port via config if you prefer;
39
+
40
+
{
41
+
"db": {
42
+
"driver": "MongoDB",
43
+
"host": "example.com",
44
+
"port": 27018
45
+
}
46
+
}
47
+
48
+
49
+
## Questions & Issues
50
+
51
+
Bug reports, feature requests and support queries can be filed as [issues on GitHub](https://github.com/saplingjs/db-driver-mongodb/issues). Please use the templates provided and fill in all the requested details.
52
+
53
+
54
+
## Changelog
55
+
56
+
Detailed changes for each release are documented in the [release notes](https://github.com/saplingjs/db-driver-mongodb/releases).
57
+
58
+
59
+
## License
60
+
61
+
[Mozilla Public License 2.0](https://opensource.org/licenses/MPL-2.0)
0 commit comments