Updated symlinks, added scripts, updated readme (ohcnetwork#404)

* Updated symlinks, added scripts, updated markdown

* added build command

* remove yarn lock

* gitignore

* maybe this works

* pnpm lock

* build command change

* wrong script mb

* minor change to package json

.env

@@ -15,4 +15,7 @@ NEXT_PUBLIC_META_URL=https://leaderboard.ohc.network
 ## -- Page Details -- ##
 NEXT_PUBLIC_PAGE_TITLE=OHC Network Contributors
 NEXT_PUBLIC_CONTRIBUTORS_INFO=""
-NEXT_PUBLIC_LEADERBOARD_DEFAULT_ROLES=core,intern,contributor
+NEXT_PUBLIC_LEADERBOARD_DEFAULT_ROLES=core,intern,contributor
+
+## -- Data Source -- ##
+DATA_SOURCE=https://github.com/coronasafe/leaderboard-data.git

.eslintrc.json

@@ -10,7 +10,13 @@
     "tailwindcss/classnames-order": "error",
     "tailwindcss/enforces-shorthand": "off",
     "tailwindcss/no-contradicting-classname": "error",
-    "tailwindcss/enforces-negative-arbitrary-values": "off"
+    "tailwindcss/enforces-negative-arbitrary-values": "off",
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ]
   },
-  "ignorePatterns": ["data"]
+  "ignorePatterns": ["data"]  
 }

.gitignore

@@ -39,4 +39,8 @@ data-repo
 
 #IDE
 .idea
-.vscode
+.vscode
+
+# Package Lock
+package-lock.json
+yarn.lock

.prettierignore

@@ -1,4 +1,2 @@
 # Ignore data
-./data
-./contributors
 ./data-repo

README.md

@@ -4,21 +4,15 @@ A simple leaderboard app built with Next.js and Tailwind CSS to list top contrib
 
 ## Getting Started
 
-### Starting the deployment server
-
-Run the following command in the terminal:
-
-```bash
-./load-org-data.sh
-```
+### Starting the development server
 
 Install dependencies:
 
 ```bash
 pnpm install
 ```
 
-Now run the deployment server:
+Now run the development server:
 
 ```bash
 pnpm dev
@@ -64,37 +58,26 @@ All members marked with `role: core` and `role: operations` will be will be hidd
 
 You will be able to see the users profile page at `http://localhost:3000/contributors/john-doe`.
 
-## Customizing the app
+# Customizing the app
 
 1. To add or remove a badge, edit the `config/GraduateAttributes.ts` file.
 
 2. To Setup the repo for a new org, update
-   the [scraper config](https://github.com/coronasafe/leaderboard/blob/d42c7b7ba608c4911d932e92679ab1914371c8a0/.github/workflows/main.yml#L32)
+   the [scraper config](https://github.com/coronasafe/leaderboard/blob/060d88f1caf2190792beffaa464a2a48bfa6f2db/.github/workflows/scraper.yaml#L40) and update the `DATA_SOURCE` variable in the `.env` file to match the repo containing your organization data.
 
 3. To change the colors, fonts, or plugins edit the `tailwind.config.js` file.
 
-### Environment Variables
-
-#### **Organization Details**
-
-- **NEXT_PUBLIC_ORG_NAME**
-  - Will be displayed in the navbar.
-- **NEXT_PUBLIC_ORG_INFO**
-  - (Optional) Will be displayed in the "What do we do?" section.
-- **NEXT_PUBLIC_ORG_LOGO**
-  - Will be displayed in the footer.
-
-#### **SEO details**
-
-- **NEXT_PUBLIC_META_TITLE**
-- **NEXT_PUBLIC_META_IMG**
-- **NEXT_PUBLIC_META_DESCRIPTION**
-- **NEXT_PUBLIC_META_URL**
-
-#### **Page Details**
-
-- **NEXT_PUBLIC_PAGE_TITLE**
-  - Will be displayed in page title.
-- **NEXT_PUBLIC_CONTRIBUTORS_INFO**
-  - (Optional) Will be displayed next to "Our Contributors" section. You can use it to display a note about your
-    contributors.
+## Environment Variables
+
+| Variable | Description | Default | Optional? |
+|---|---|---|---|
+| **NEXT_PUBLIC_ORG_NAME** | Will be displayed in the navbar | ohc.network | No |
+| **NEXT_PUBLIC_ORG_INFO** | Will be displayed in the "What do we do?" section. | Open Healthcare Network is a free and open-source disaster management system that is used by National Health Mission, Government of India and various state governments for reimaging digital war rooms. The solution that students got an opportunity to intern with has supported 3.34Lac patient management and 1.29 Lac ambulance shiftings and is approved by the United Nations as a Digital Public Good. | Yes |
+| **NEXT_PUBLIC_ORG_LOGO** | Will be displayed in the footer. | /logo.webp | No |
+| **NEXT_PUBLIC_META_TITLE** | Metadata title | Open Healthcare Network | No |
+| **NEXT_PUBLIC_META_IMG** | Metadata img | /logo.webp | No |
+| **NEXT_PUBLIC_META_DESCRIPTION** | Metadata description | OHC Network Leaderboard tracks the weekly progress of all coronasafe contributors. | No |
+| **NEXT_PUBLIC_META_URL** | Metadata url | https://leaderboard.ohc.network | No |
+| **NEXT_PUBLIC_PAGE_TITLE** | Will be displayed in page title. | OHC Network Contributors | No |
+| **NEXT_PUBLIC_CONTRIBUTORS_INFO** | Will be displayed next to "Our Contributors" section. You can use it to display a note about your contributors. |  | Yes |
+| **DATA_SOURCE** | Url for data repository | https://github.com/coronasafe/leaderboard-data.git | Yes |

app/globals.css

@@ -1,4 +1,4 @@
-@import "../theme.css";
+@import "../data-repo/config/theme.css";
 @tailwind base;
 @tailwind components;
 @tailwind utilities;
@@ -129,4 +129,4 @@ html.dark {
   opacity: 100;
   transform: translateX(0px);
   transform: translateY(0px);
-}
+}

lib/api.ts

@@ -4,9 +4,9 @@ import { Activity, ActivityData, Contributor, Highlights } from "./types";
 import { padZero } from "./utils";
 import { readFile, readdir } from "fs/promises";
 
-const root = join(process.cwd(), "contributors");
-const slackRoot = join(process.cwd(), "data/slack");
-const githubRoot = join(process.cwd(), "data/github");
+const root = join(process.cwd(), "data-repo/contributors");
+const slackRoot = join(process.cwd(), "data-repo/data/slack");
+const githubRoot = join(process.cwd(), "data-repo/data/github");
 
 const points = {
   comment_created: 1,

package.json

@@ -3,13 +3,14 @@
   "version": "0.1.0",
   "private": true,
   "scripts": {
-    "dev": "next dev",
-    "build": "next build",
+    "dev": "node ./scripts/checkData.js && next dev",
+    "build": "node ./scripts/loadOrgData.js && next build",
     "start": "next start",
     "lint": "next lint",
     "lint-fix": "eslint . --fix",
     "format": "prettier --write .",
-    "prepare": " husky install"
+    "load-data": "node ./scripts/loadOrgData.js",
+    "prepare": "husky install"
   },
   "dependencies": {
     "@headlessui/react": "^1.7.18",
@@ -39,6 +40,7 @@
     "@types/node": "^20.11.21",
     "@types/react": "^18.2.60",
     "autoprefixer": "^10.4.17",
+    "dotenv": "^16.4.5",
     "eslint": "8.16.0",
     "eslint-config-next": "^14.1.0",
     "eslint-config-prettier": "^9.1.0",
@@ -52,4 +54,4 @@
     "tailwindcss": "^3.4.1",
     "typescript": "^5.3.3"
   }
-}
+}

scripts/checkData.js

@@ -0,0 +1,33 @@
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const dotenv = require('dotenv');
+dotenv.config();
+
+const dataRepoDir = "data-repo";
+
+const askYN = (question, def, ycallback, ncallback) => {
+    console.log(`${question} (${def ? 'Y/n' : 'y/N'})`);
+    const stdin = process.openStdin();
+    stdin.addListener('data', function (d) {
+        const input = d.toString().trim().toLowerCase();
+        stdin.removeAllListeners('data');
+        if (input === 'y' || (!input && def)) {
+            ycallback();
+        } else if (input === 'n' || (!input && !def)) {
+            ncallback();
+        } else {
+            askYN(question, def, ycallback, ncallback);
+        }
+    });
+}
+if (!fs.existsSync(path.join(process.cwd(), dataRepoDir))) {
+    console.log("Looks like you have not loaded any data.")
+    askYN("Download data now?", true, () => {
+        execSync(`node scripts/loadOrgData.js`, { stdio: 'inherit' })
+        process.exit(0);
+    }, () => {
+        console.log("Aborting...");
+        process.exit(1);
+    });
+}

scripts/generateNewContributors.js

@@ -19,11 +19,11 @@ Still waiting for this
 function getNewContributors() {
   let newContributors = new Set();
 
-  fs.readdirSync("./data/github").forEach((file) => {
+  fs.readdirSync("./data-repo/data/github").forEach((file) => {
     newContributors.add(file.split(".")[0]);
   });
 
-  fs.readdirSync("./contributors").forEach((file) => {
+  fs.readdirSync("./data-repo/contributors").forEach((file) => {
     newContributors.delete(file.split(".")[0]);
   });
 
@@ -54,7 +54,7 @@ function main() {
       .then((data) => {
         if (data.name === null) data.name = data.login;
         fs.writeFile(
-          `./contributors/${data.login}.md`,
+          `./data-repo/contributors/${data.login}.md`,
           generateContent(data.name, data.login),
           (err) => {
             if (err) throw err;

scripts/loadOrgData.js

@@ -0,0 +1,47 @@
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const dotenv = require('dotenv');
+dotenv.config();
+
+const DATA_SOURCE = process.env.DATA_SOURCE || null;
+if (!DATA_SOURCE) {
+    console.error('Please provide a DATA_SOURCE environment variable');
+    process.exit(1);
+}
+const cwd = process.cwd();
+const dataRepoPath = path.join(cwd, 'data-repo');
+
+function executeCommand(command, workingDir = cwd) {
+    try {
+        const result = execSync(command, { cwd: workingDir, stdio: 'inherit' });
+        return result;
+    } catch (error) {
+        console.error(`Error executing command: ${command}`, error);
+    }
+}
+
+if (fs.existsSync(path.join(dataRepoPath, '.git'))) {
+    console.log("Updating existing data repository...");
+    const remotes = executeCommand('git remote -v', dataRepoPath)
+    if (remotes && remotes.includes('upstream')) {
+        executeCommand('git clean -df', dataRepoPath);
+        executeCommand('git fetch upstream', dataRepoPath);
+        executeCommand('git checkout --force main', dataRepoPath);
+        executeCommand('git reset --hard main', dataRepoPath);
+        executeCommand('git pull upstream main', dataRepoPath);
+    }
+} else {
+    console.log("Cloning data repository for the first time...");
+
+    fs.rmSync(dataRepoPath, { recursive: true, force: true });
+    executeCommand(`git clone ${DATA_SOURCE} ${dataRepoPath}`);
+    executeCommand('git remote add upstream ' + DATA_SOURCE, dataRepoPath);
+    executeCommand('git remote remove origin', dataRepoPath);
+    executeCommand('git pull upstream main', dataRepoPath);
+}
+
+if (fs.existsSync(path.join(dataRepoPath, 'config/assets'))) {
+    console.log("Copying assets to public folder...");
+    fs.cpSync(path.join(dataRepoPath, 'config/assets'), path.join(cwd, 'public'), { recursive: true });
+}

scripts/slackEODReminder.js

@@ -4,7 +4,7 @@ const matter = require("gray-matter");
 const { readFile, readdir } = require("fs/promises");
 const { join } = require("path");
 
-const root = join(process.cwd(), "contributors");
+const root = join(process.cwd(), "data-repo/contributors");
 
 const GITHUB_ORG = process.env.GITHUB_ORG;
 const GITHUB_TOKEN = process.env.GITHUB_TOKEN;

vercel.json

@@ -1,3 +1,4 @@
 {
-  "framework": "nextjs"
-}
+  "framework": "nextjs",
+  "buildCommand": "node ./scripts/loadOrgData.js && next build"
+}