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
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+11-3
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ This project uses [editor config](https://editorconfig.org/), please make sure t
9
9
10
10
*[Git](https://git-scm.com/)
11
11
*[node.js](https://nodejs.org/)*(see [`./package.json`](https://github.com/OpenUserJs/OpenUserJS.org/blob/master/package.json) engines for specific requirements)*
12
-
*[MongoDB](https://www.mongodb.org/)(Optional. The project is preconfigured to use a dev DB on [mLab](https://mlab.com/).)
12
+
*[MongoDB](https://www.mongodb.org/)*(Required: See [overall instructions here](https://docs.mongodb.com/manual/installation/) or [Community Edition instructions](https://docs.mongodb.com/manual/administration/install-community/))*
13
13
14
14
#### GitHub Fork Setup
15
15
@@ -32,11 +32,19 @@ This project uses [editor config](https://editorconfig.org/), please make sure t
32
32
#### Configuration
33
33
34
34
1. Navigate to https://github.com/settings/applications and register a new OAuth application, saving the Client ID and Secret. To ensure GitHub OAuth authentication will work the "Authorization callback URL" value must exactly match `AUTH_CALLBACK_BASE_URL` (see below, e.g. http://localhost:8080).
35
-
2. Open a [MongoDB shell](https://docs.mongodb.com/manual/mongo/) and run the following (replacing "your_GitHub_client_ID" and "your_GitHub_secret") to create an "oujs_dev" database with a "strategies" collection containing your application instance's GitHub OAuth information.
36
-
*`use oujs_dev`
35
+
2. Open a [MongoDB shell](https://docs.mongodb.com/manual/mongo/) and run the following (replacing "your_GitHub_client_ID" and "your_GitHub_secret") to create an "openuserjs_devel" database with a "strategies" collection containing your application instance's GitHub OAuth information.
3. Edit `models/settings.json`, setting your desired session secret, [MongoDB connection string](https://docs.mongodb.com/manual/reference/connection-string/) (if using your own MongoDB instance), etc.
40
+
4. Depending on how you installed MongoDB you may need to set an environment variable in your CLI:
5. You may import a “dirty” database using `mongorestore --gzip --db openuserjs_devel --archive=./dev/devDBdirty.gz` from the projects home.
0 commit comments