From 1573d92831103ce42c3d5258160286b9649094f0 Mon Sep 17 00:00:00 2001 From: vipul kumar <2400031116@kluniversity.in> Date: Fri, 31 Oct 2025 08:27:19 +0530 Subject: [PATCH] Simplify README setup instructions and add local.js (fixes #500) --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3a0b62583..5cf8749d61 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,15 @@ This Project serves the backend APIs required for [Real Dev Squad](https://reald ## Prerequisites - The application uses [node-config](https://github.com/lorenwest/node-config)([documentation](https://github.com/lorenwest/node-config/wiki/Configuration-Files)) for managing config. -- Create a new file: `config/local.js`. Override the required config values from `config/development.js` and `config/default.js` into `config/local.js`. +-Create a new file: `config/local.js`. + +To make setup easier, you can simply copy all the contents from `config/development.js` into `config/local.js`. +Then, update only the GitHub OAuth credentials with your own values: + +```js +clientId: "", +clientSecret: " +" - Register the application for [GitHub OAuth](https://docs.github.com/en/developers/apps/creating-an-oauth-app) to get the `clientId` and `clientSecret`. Add the callback URL as `http://:/auth/github/callback` - Create an application on [FireStore](https://firebase.google.com/docs/firestore) and [generate a service file](https://cloud.google.com/iam/docs/creating-managing-service-account-keys). Add the service file credentials in the local config (or your env variables) as a string. Make sure you convert all the escape sequence (newline) - `\n` with `\\n` in private_key field. - For running the project locally, [Firebase Local Emulator Suite](https://firebase.google.com/docs/emulator-suite) can also be used instead of using the remote DB. Steps for setting it up: [CONTRIBUTING.md - Using Firebase Emulator Locally](https://github.com/Real-Dev-Squad/website-backend/blob/develop/CONTRIBUTING.md#using-firebase-emulator-locally)