krishnan05 · krishnan05 · Jun 14, 2023 · Jun 14, 2023 · Jun 17, 2023 · Jun 17, 2023
diff --git a/.github/ISSUE_TEMPLATE/no_code.md b/.github/ISSUE_TEMPLATE/no_code.md
@@ -0,0 +1,33 @@
+---
+name: No Code
+about: Addition of a No Code feature to the project.
+title: ''
+labels: No code , Technical Writing
+assignees: ''
+
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Description
+<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->
+
+## Expected Behavior
+<!--- Tell us what should happen -->
+
+## Actual Behavior
+<!--- Tell us what happens instead -->
+
+## Possible Fix
+<!--- Not obligatory, but suggest a fix or reason for the bug -->
+
+## Steps to Reproduce
+<!--- Provide a link to a live example or some unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- How has this bug affected you? What were you trying to accomplish? -->
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 node_modules
-
+*.env
 *.lock
 *.log
-
+*.env
 *.pyc
 *.sqlite3
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,38 @@
+# Start with an Ubuntu base image
+FROM ubuntu:latest
+
+# Install Python and other necessary packages
+RUN apt-get update && apt-get install -y \
+    python3 \
+    python3-pip \
+    python3-venv \
+    curl \
+    make \
+    redis-server \
+    git
+
+# Install Node.js (for React)
+RUN curl -sL https://deb.nodesource.com/setup_20.x | bash - \
+    && apt-get install -y nodejs
+
+# Install pnpm
+RUN npm install -g pnpm
+
+# Set the working directory in the container
+WORKDIR /usr/src/app
+
+# Copy the project files into the container
+COPY . .
+
+# Set up Python virtual environment
+RUN python3 -m venv env
+ENV PATH="/usr/src/app/env/bin:$PATH"
+
+# Install dependencies
+RUN make install
+
+# Expose ports (Django and React)
+EXPOSE 8000 3000
+
+# Run the application
+CMD ["make", "dev"]
diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@ migrate:
 dev-ui:
 	cd app/ && $(PNPM) run start
 
-dev-server: migrate
+dev-server:
 	cd api/ && $(PYTHON) manage.py runserver &
 
 celery-1:
@@ -22,5 +22,10 @@ celery-1:
 celery-2:
 	cd api/ && celery -A leaderboard beat -l info
 
-dev: dev-server dev-ui celery-1 celery-2
+dev:
 	@echo 'Starting dev servers'
+	$(MAKE) migrate
+	$(MAKE) dev-ui &
+	$(MAKE) dev-server &
+	$(MAKE) celery-1 &
+	$(MAKE) celery-2
diff --git a/README.md b/README.md
@@ -1,28 +1,104 @@
 <h1 align="center">Welcome to the Leaderboard project 👋</h1>
 
 ## 🤔 Problem
-How do people become good at something ? By doing it regularly, right ? That's why this project aims to help all the students in practicing programming regularly by maintaining a leaderboard. The website will be have **4 different leaderboards**
+How do people become good at something ? By doing it regularly, right ? That's why this project aims to help all the students in practicing programming regularly by maintaining a leaderboard. The website will be have **6 different leaderboards**
 
 ## ✨ Features
 - LeaderBoard Website + Django backend to collect data from different sources( APIs and web scraping )
 - Leaderboard type 1 : Github profile activeness (based on commits/stars etc.)
 - Leaderboard type 2 : OpenLake contributions (based on commits/pull requests etc.)
 - Leaderboard type 3 : Codechef ranking
 - Leaderboard type 4 : Codeforces ranking
+- Leaderboard Type 5 : Leetcode ranking
+- Leaderboard type 6 : Leetcode contest ranking
+- Students can also view the rankings of the latest LeetCode contests, their institute rank and visualise contest performance through graph.
 - Students will get notified(through email) whenever their rank is decreasing (because they aren't active)
 - Our metrics will promote consistent work instead of bulk work at once.
-- Tech Stack : React, Django, PostgreSQL
+- Tech Stack : React, Django, PostgreSQL, MongoDB (for Friend's Table)
 
-## Setup instrunctions
-- Install `pnpm`, `python3.7` and `Make` in your system
+## 📝 Setup instructions
+- Install `pnpm`, To obtain installation instructions for the pnpm package manager on your operating system, please refer to the following [link](https://pnpm.io/installation).
+- Install `python3.7`
+    - Ensure that you are in project folder
+    - Create a virtual Environment
+        ```
+        python3 -m venv <ENVIRONMENT_NAME>
+        ```
+    - Activate the virtual Environment
+        ```
+        source <ENVIRONMENT_NAME>/bin/activate
+        ```
+- Install `make`
+    - For Ubuntu:
+        ```
+        sudo apt update
+        sudo apt install make
+        ```
+    - For Mac OS:
+        - In the terminal window, run the command ```xcode-select --install```
+        - In the windows that pops up, click Install, and agree to the Terms of Service.
+    - For Windows, follow the [link](https://linuxhint.com/install-use-make-windows/)
+- Install Redis 
+    - For Ubuntu, follow the [link](https://redis.io/docs/install/install-redis/install-redis-on-linux/)
+    - For MacOS, follow the [link](https://redis.io/docs/install/install-redis/install-redis-on-mac-os/)
+    - For Windows, follow the [link](https://redis.io/docs/install/install-redis/install-redis-on-windows/)
+- Replace database credentials
+    - Create a new project on Supabase
+    - Go to `Project Settings > Database`
+    - Open the project in prefered code-editor
+    - Go to `Leaderboard-Pro > api > leaderboard > settings.py`, scroll down to `DATABASES` variable and change the `NAME`, `USER`, `PASSWORD`, `HOST` and `PORT` as on the Supabase Database page. 
 - Run the following commands in the same order:
     ```
     make install
-    make migrate
     make dev
     ```
 - Visit http://localhost:8000/ and http://localhost:3000/
 
-## Maintainers
+## 🐳 Running with Docker
+
+Docker provides a consistent and isolated environment for running the Leaderboard project, ensuring that it works the same way on every machine. Follow these steps to get the application up and running with Docker:
+
+### Prerequisites
+- Ensure you have Docker installed on your machine. To install Docker, follow the instructions on the [Docker website](https://docs.docker.com/get-docker/).
+
+### Building the Docker Image
+1. Clone the repository (if you haven't already):
+    ```
+    git clone https://github.com/your-username/Leaderboard-Pro.git
+    cd Leaderboard-Pro
+    ```
+
+2. Build the Docker image:
+    ```
+    docker build -t leaderboard-pro .
+    ```
+
+   This command builds a Docker image named `leaderboard-pro` based on the instructions in the Dockerfile.
+
+### Running the Application in a Docker Container
+1. To start the application in a Docker container, run:
+    ```
+    docker run -p 8000:8000 -p 3000:3000 leaderboard-pro
+    ```
+
+   This command starts the Docker container and maps the ports so that you can access the Django backend at `http://localhost:8000/` and the React frontend at `http://localhost:3000/`.
+
+2. Visit the URLs in your web browser to interact with the application:
+    - Django Backend: [http://localhost:8000/](http://localhost:8000/)
+    - React Frontend: [http://localhost:3000/](http://localhost:3000/)
+
+### Stopping the Container
+- To stop the Docker container, you can press `Ctrl+C` in the terminal where the container is running. Alternatively, you can stop the container from another terminal using the `docker stop` command with the container ID.
+
+
+## 🧑‍💻 Maintainers
 - [Gopal Ramesh Dahale](https://github.com/Gopal-Dahale)
 - [Kumar Shivendu](https://github.com/KShivendu)
+- [Aayush Krishnan](https://github.com/krishnan05)
+- [Aditya Dubey](https://github.com/Aditya062003)
+
+## 💻 Contributing Guidelines
+- Read [contributing guidelines](https://github.com/OpenLake/Leaderboard-Pro/blob/main/.github/CONTRIBUTING.md)
+
+## 👀 Hosted App
+[https://openlake-leaderboardpro.vercel.app](https://openlake-leaderboardpro.vercel.app)
diff --git a/api/Makefile b/api/Makefile
@@ -0,0 +1,22 @@
+PYTHON ?= python3
+PIP ?= pip3
+
+migrate:
+	$(PYTHON) manage.py makemigrations
+	$(PYTHON) manage.py migrate
+
+dev-server:
+	$(PYTHON) manage.py runserver &
+
+celery-1:
+	celery -A leaderboard worker --loglevel=info
+
+celery-2:
+	celery -A leaderboard beat -l info
+
+dev:
+	@echo 'Starting dev servers'
+	$(MAKE) migrate
+	$(MAKE) dev-server &
+	$(MAKE) celery-1 &
+	$(MAKE) celery-2
diff --git a/api/leaderboard/admin.py b/api/leaderboard/admin.py
@@ -6,19 +6,11 @@
     openlakeContributor,
     UserNames,
     LeetcodeUser,
-    GithubFriends,
-    LeetcodeFriends,
-    CodechefFriends,
-    CodeforcesFriends,
 )
 
 admin.site.register(codeforcesUser)
 admin.site.register(githubUser)
 admin.site.register(codechefUser)
 admin.site.register(openlakeContributor)
 admin.site.register(UserNames)
-admin.site.register(LeetcodeUser)
-admin.site.register(GithubFriends)
-admin.site.register(LeetcodeFriends)
-admin.site.register(CodechefFriends)
-admin.site.register(CodeforcesFriends)
+admin.site.register(LeetcodeUser)
diff --git a/api/leaderboard/api/serializers.py b/api/leaderboard/api/serializers.py
diff --git a/api/leaderboard/api/urls.py b/api/leaderboard/api/urls.py
@@ -14,21 +14,8 @@
     path('insertapi/',views.post_UserNames),
     path('tripathi/',views.current_user),
     path('register/',views.registerUser),
-    path('ghfriends/',views.add_GithubFriends),
-    path('ltfriends/',views.add_LeetcodeFriends),
-    path('ccfriends/',views.add_CodechefFriends),
-    path('cffriends/',views.add_CodeforcesFriends),
-    path('getcffriends/',views.get_CodeforcesFriends),
-    path('dropcffriends/',views.drop_CodeforcesFriends),
-    path('getccfriends/',views.get_CodechefFriends),
-    path('dropccfriends/',views.drop_CodechefFriends),
-    path('getltfriends/',views.get_LeetcodeFriends),
-    path('dropltfriends/',views.drop_LeetcodeFriends),
-    path('getghfriends/',views.get_GithubFriends),
-    path('dropghfriends/',views.drop_GithubFriends),
-    path('olfriends/',views.add_OpenlakeFriends),
-    path('getolfriends/',views.get_OpenlakeFriends),
-    path('dropolfriends/',views.drop_OpenlakeFriends),
+    path('leetcodecontestrankings/',views.ContestRankingsAPIView),
+
 ]