Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev #149

Merged
merged 8 commits into from
Jun 10, 2020
Merged

Dev #149

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ yarn-error.log
# Code coverage
coverage

# Functional documentation
func-doc

# Config
config/production.json

Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,21 @@ npm run import
"FBClientSecret": "2",
"GoogleClientID": "3",
"GoogleClientSecret": "4Bar",
"GithubClientID": "FooBar",
"GithubClientSecret": "Baz123",
"SENDGRID_API_KEY": "6Baz",
"Firebase_Service_Acc": {
"type": "XXXXXX",
"project_id": "XXXXXX",
"private_key_id": "XXXXXX",
"private_key": "XXXXXX",
"client_email": "XXXXXX",
"client_id": "XXXXXX",
"auth_uri": "XXXXXX",
"token_uri": "XXXXXX",
"auth_provider_x509_cert_url": "XXXXXX",
"client_x509_cert_url": "XXXXXX"
},
"db": "mongodb://localhost:27017/YourCollection",
"PORT": "3000",
"NODE_ENV": "production"
Expand All @@ -101,7 +115,9 @@ npm run import
> Eg: `60`, `"2 days"`, `"10h"`, `"7d"`. A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default (`"120"` is equal to `"120ms"`).
* `FBClientID` and `FBClientSecret`: Are used for signing up with facebook.
* `GoogleClientID` and `GoogleClientSecret`: Are used for signing up with google.
* `GithubClientID` and `GithubClientSecret`: Are used for signing up with GitHub.
* `SENDGRID_API_KEY`: The api key for sending emails through sendgrid
* `Firebase_Service_Acc`: This object has credentials of firebase that is used for pushing notifications. More Details Here [Add Firebase to your JavaScript project](https://firebase.google.com/docs/web/setup)
* `db`: Your database path
> Eg: `"mongodb://localhost:27017/YourCollection"` If you're hosting on your localhost server.
* `PORT`: Your api hosting port
Expand Down
2 changes: 2 additions & 0 deletions config/development.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"FBClientSecret": "1",
"GoogleClientID": "1",
"GoogleClientSecret": "1",
"GithubClientID": "1",
"GithubClientSecret": "1",
"SENDGRID_API_KEY": "SG.1",
"Firebase_Service_Acc": {},
"db": "mongodb://localhost:27017/oud",
Expand Down
Loading