documention

Author: samratmiddha

README.md

@@ -6,17 +6,20 @@ GSoC: Google Summer of Code; 'Oscar of the Coding World', as they popularly call
 
 ## Link to website: https://sparsh1212.github.io/gsocanalyzer/
 
-
 ### Home Page
+
 ![1](./readme-assets/homePage.png)
 
 ### Search by organisation name
+
 ![1](./readme-assets/searchByOrganisation.png)
 
 ### Search by tech-stack
+
 ![1](./readme-assets/searchByTechStack.png)
 
-## Bookmark 
+## Bookmark
+
 ### Bookmarking feature allows you to save your favorite organisation and then quickly access them in the browser.
 
 Steps to bookmark an organization.
@@ -37,9 +40,8 @@ You can reset all your bookmarks by clicking the Reset Bookmarks button, which i
 
 ![1](./readme-assets/resetBookmark.png)
 
-
-
 # Setup:
+
 - Clone the repo
 - cd into the repo directory
 - Run: `npm install`
@@ -51,3 +53,14 @@ You can reset all your bookmarks by clicking the Reset Bookmarks button, which i
 - Create a new branch named <your_feature>
 - Commit changes and make a PR.
 - PRs are welcome.
+
+# Updating Data:
+
+- Setup gsoc analyzer using the steps mentioned above
+- In `./scrape.py` replace 2023 with the {year}+1
+- Run: `python scrape.py`
+- Replace the data in ./data/finalData.json with the new data in ./data.json(produced after successfully running scrape script)
+- Identify duplicate entries of organizations in data obtained through scraping (produced due to slightly different name in various year of gsoc)
+- for each duplicate org Run : `python merge.py`
+- add {year} to labels in `./components/OrganisationCard.js`
+- for charts in `./components/launcher/` add {year} to the labels and add the data for the year

readme-assets/BookmarkBar.png

@@ -1,4 +1,3 @@
-
 import html5lib
 from bs4 import BeautifulSoup
 import json

readme-assets/BookmarkNotAdded.png

@@ -12,9 +12,6 @@ import {
 } from "chart.js";
 import "../../css/graphcss.css";
 
-// Chart.defaults.plugins.tooltip.enabled = true;
-// Chart.defaults.plugins.legend.position = "bottom";
-
 const OrganizationChart = (props) => {
   Chart.defaults.font.size = props.font;
   Chart.register(

readme-assets/BookmarkSuccessfullAdded.png

@@ -10,10 +10,6 @@ import {
   Tooltip,
 } from "chart.js";
 import "../../css/graphcss.css";
-// Chart.defaults.plugins.tooltip.enabled = true;
-// // console.log(defaults.plugins.legend.position);
-// Chart.defaults.plugins.legend.position = "bottom";
-
 const ParticipantChart = (props) => {
   Chart.defaults.font.size = props.font;
   Chart.register(CategoryScale, BarElement, PointElement, Legend, Tooltip);

readme-assets/homePage.png

@@ -91,13 +91,22 @@ const OrganisationCard = ({ key, orgData, bookmarked, setBookmarked }) => {
               options={{
                 maintainAspectRatio: false,
                 scales: {
-                  yAxes: [
-                    {
-                      ticks: {
-                        precision: 0,
+                  y: {
+                    ticks: {
+                      precision: 0,
+                      font: {
+                        size: 12,
                       },
                     },
-                  ],
+                  },
+                  x: {
+                    ticks: {
+                      precision: 0,
+                      font: {
+                        size: 12,
+                      },
+                    },
+                  },
                 },
               }}
             />