Merge branch 'master' into fix-image-pdf-size

anshika208 · May 31, 2021 · f01e078 · f01e078
2 parents da64247 + 22c0840
commit f01e078
Show file tree

Hide file tree

Showing 58 changed files with 3,864 additions and 3,847 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,43 +1,26 @@
 module.exports = {
-	"env": {
-		"browser": true,
-		"es2021": true,
-		"node": true,
-		"jest":true
-	},
-	"extends": [
-		"eslint:recommended",
-		"plugin:react/recommended"
-	],
-	"parserOptions": {
-		"ecmaFeatures": {
-			"jsx": true
-		},
-		"ecmaVersion": 12,
-		"sourceType": "module"
-	},
-	"plugins": [
-		"react"
-	],
-	"rules": {			
-		"react/prop-types": "off",
-		"no-mixed-spaces-and-tabs": 0,
-		"react/no-unescaped-entities": 0,
-		"indent": [
-			"error",
-			"tab"
-		],
-		"linebreak-style": [
-			"error",
-			"unix"
-		],
-		"quotes": [
-			"error",
-			"double"
-		],
-		"semi": [
-			"error",
-			"always"
-		]
-	}
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+    jest: true,
+  },
+  extends: ["eslint:recommended", "plugin:react/recommended"],
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 12,
+    sourceType: "module",
+  },
+  plugins: ["react"],
+  rules: {
+    "react/prop-types": "off",
+    "no-mixed-spaces-and-tabs": 0,
+    "react/no-unescaped-entities": 0,
+    indent: ["error", "tab"],
+    "linebreak-style": ["error", "unix"],
+    quotes: ["error", "double"],
+    semi: ["error", "always"],
+  },
 };
diff --git a/.github/workflows/prettier_action_on_PR_and_push.yml b/.github/workflows/prettier_action_on_PR_and_push.yml
@@ -0,0 +1,26 @@
+name: Continuous Integration
+
+# This action works with pull requests and pushes
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        # Make sure the actual branch is checked out when running on pull requests
+        ref: ${{ github.head_ref }}
+
+    - name: Prettify code
+      uses: creyD/[email protected]
+      with:
+        prettier_options: --write **/*.{js,jsx,scss,md}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,63 +2,72 @@
 
 <p align="center"><img src="./readme_assets/Contribute.png" width=600></p>
 
-
 #### Preliminaries:
+
 - Download and install the latest stable version of [Git](https://git-scm.com/downloads) 📥 for version control
-- Create a [Github](https://github.com/join) Account 📇 
+- Create a [Github](https://github.com/join) Account 📇
 - Download and install latest stable version of [NodeJS](https://nodejs.org/en/download/)
 - Download and install latest stable version of [VS Code](https://code.visualstudio.com/download)
 
-- Fork [this](https://github.com/smaranjitghose/doc2pen) repository 
+- Fork [this](https://github.com/smaranjitghose/doc2pen) repository
 <p align = "center"><img src="/readme_assets/Fork%20Project.png?raw=true" width="500" height="200"/></p>
 
-
 - Open Terminal/Command Prompt/Powershell/Git Bash and navigate to a location where you want the project files to be stored
+
 ```
 cd D:\my_preferred_location
 ```
+
 - Clone your forked repository 🧩.
+
 ```
 git clone https://github.com/<your_user_name>/doc2pen.git
 ```
+
 - Now move inside the project directory 📁 (using the terminal).
+
 ```
 cd doc2pen
 ```
+
 - Check for the current remotes of the git repository (the local copy of your forked repository)
+
 ```
 git remote --verbose
 ```
+
 - Add add a reference to the upstream(this repository which you clones) repository.
+
 ```
 git remote add upstream https://github.com/smaranjitghose/doc2pen.git
 ```
 
 - Install the dependencies and packages
- ```
- npm install
- ```
-- Start the react app in the local server in development mode 
+
+```
+npm install
+```
+
+- Start the react app in the local server in development mode
+
 ```
 npm start
 ```
 
 > ### Using Docker to run the web app
-> 
+>
 > - Install [Docker](https://docs.docker.com/engine/install/) if you don't have it already.
->  
+>
 > - Build the project
->  
->  ``docker-compose build``
->   
+>
+> `docker-compose build`
+>
 > - Run the docker container
->   
->   ``docker compose up``
-
+>
+>   `docker compose up`
 
 - Open your favourite browser and navigate to `http://localhost:3000` to view the current version of the app
 
-
 - Open the project files in VSCode (assuming you have already opened the terminal and navigated inside the project directory)
 
 ```
@@ -73,33 +82,28 @@ git pull upstream master
 
 - Comment on any existing [issue(s)](https://github.com/smaranjitghose/doc2pen/issues) raised by **project maintainers** [@smaranjitghose or @anushbhatia]. Otherwise raise a [new issue](https://github.com/smaranjitghose/doc2pen/issues/new).
 
-
-
-
-
-
 > ## Guidelines for raising a new issue:
 >
 > - Each issue should have an appropriate and short title like "Bug in Upload Page"
-> 
+>
 > - Be specific about your intended changes/suggestions
 >
 > - Refrain from using phrases like "Hi, I am ..", "Please assign me this issue", "Thank You..", etc. We are only interested in technical parts
 >
 > - Attach a screenshot/clip if applicable
 >
 > - Please be patient enough. The project maintainers/mentors would review it as per their schedule. Please do not start putting comments like "Please check this" etc.
->  
-> - Do not blindly comment on issues raised by other participant(s). Unless a minimum of 48 hours has passed since their assignment, the issue would not be re-assigned(excluding certain cases). The issue raised by a participant will always to be assigned to him/her by default. Do not spam "Interested", "Please assign me" in others issues. 
-> 
-> - Always keep a note of the deadline. 
+>
+> - Do not blindly comment on issues raised by other participant(s). Unless a minimum of 48 hours has passed since their assignment, the issue would not be re-assigned(excluding certain cases). The issue raised by a participant will always to be assigned to him/her by default. Do not spam "Interested", "Please assign me" in others issues.
+>
+> - Always keep a note of the deadline.
 
 - Once the project maintainer(s)/mentor(s) have reviewed the issue/assigned you the issue. Start working on the changes
 
 - Create a new feature branch (DO NOT name it MAIN or MASTER or anything random).
-   ```
-   git checkout -b <your_branch_name>
-   ```
+  ```
+  git checkout -b <your_branch_name>
+  ```
 - Finish your work
 
 - Make sure that you do not change any code unrelated to the task that you have been assigned
@@ -117,17 +121,21 @@ git pull upstream master
 - Make a small clip or take screenshots.
 
 - Stage your changes.
+
 ```
 git add .
 ```
+
 - Commit the changes.
+
 ```
 git commit -m "message relevant to your changes (usually title of the pull request)"
 ```
 
 - **Make sure to condense your changes into a single commit**. [Reference](https://levelup.gitconnected.com/how-to-squash-git-commits-9a095c1bc1fc)
 
 - Push the changes to your remote repository on GitHub.
+
 ```
 git push origin <your_branch_name>
 ```
@@ -138,67 +146,65 @@ git push origin <your_branch_name>
 > ## Guidelines for raising a pull request:
 >
 > - Each pull request should have an appropriate and short title like "Fixed Bug in Upload Page"
-> 
-> - Describe your intended changes in the description section of the pull request (Use bullet points and phrases) 
+>
+> - Describe your intended changes in the description section of the pull request (Use bullet points and phrases)
 >
 > - Refrain from using phrases like "Hi, I am ..", "Please merge me this OPR", "Thank You..", etc. We are only interested in technical parts
 >
 > - Attach a screenshot/clip of the change(s)
 >
-> - Make sure to refer the respective issue in the respective PR using phrases like `Resolves #issue_number` or `Closes #issue_number`.  
+> - Make sure to refer the respective issue in the respective PR using phrases like `Resolves #issue_number` or `Closes #issue_number`.
 >
 > - Please be patient enough. The project maintainers/mentors would review it as per their schedule. Please do not start putting comments like "Please check this" etc.
->  
+>
 > - Although we support feedback from everyone in all phases of development, it is highly advised not to put any negative comments in other participant's pull requests.
-> 
-> - Always keep a note of the deadline. 
+>
+> - Always keep a note of the deadline.
 
 <p align="center"><img src="/readme_assets/PR.JPG?raw=true" height="350" width="450"/></p>
 
-
 # Open Source Program Grading (Relevant for only for Project Maintainers)
 
-
 ## [Script Winter of Code](https://swoc.tech/)
 
 | Difficulty | Score |
-|------------|-------|
-| Beginner   | 10 |
-| Easy       | 20 |
-| Medium     | 30 |
-| Hard       | 40 |
+| ---------- | ----- |
+| Beginner   | 10    |
+| Easy       | 20    |
+| Medium     | 30    |
+| Hard       | 40    |
 
 #### Allotment:
 
 - Add relevant labels ( must contain `SWoC21`)
-- Maintain an excel sheet: 
+- Maintain an excel sheet:
 
 | Name | Username | # of Beginner | # of Easy | # of Medium | # of Hard | Total Score | PR Numbers |
-|------|----------|---------------|-----------|-------------|-----------|-------------|------------|
+| ---- | -------- | ------------- | --------- | ----------- | --------- | ----------- | ---------- |
 
 ## [Mexili Winter of Code](https://mexili.github.io/winter_of_code/#/)
 
 #### Distribution
 
 | Difficulty | Score |
-|------------|-------|
-| Easy   | 25  |
-| Medium | 50  |
-| Hard   | 100 |
+| ---------- | ----- |
+| Easy       | 25    |
+| Medium     | 50    |
+| Hard       | 100   |
 
 #### Allotment:
 
-When accepting the PR, add the following label before merging it. user=<username>:score=<score>, e.g. if the user sansyrox has filled a relevant PR and you are allotting 100 marks to him, add the following label ``user=sansyrox:score=100`` to the PR.
- 
+When accepting the PR, add the following label before merging it. user=<username>:score=<score>, e.g. if the user sansyrox has filled a relevant PR and you are allotting 100 marks to him, add the following label `user=sansyrox:score=100` to the PR.
+
 ## [IEEE DTU Cross Winter of Code](https://crosswoc.ieeedtu.in/)
 
 #### Distribution
 
 | Difficulty | Score |
-|------------|-------|
-| Easy   | - |
-| Medium | - |
-| Hard   | - |
+| ---------- | ----- |
+| Easy       | -     |
+| Medium     | -     |
+| Hard       | -     |
 
 #### Allotment:
 
@@ -207,14 +213,13 @@ When accepting the PR, add the following label before merging it. user=<username
 
 ## [GirlScript Summer of Code 2021]()
 
-| Difficulty | Intent | Score |
-|------------|--------|-------|
-| Level0  | GSSOC Minor Documentation | 5 |
-| Level1  | GSSOC Major Documentation  | 10 |
-| Level2  | GSSOC Bug fixing, adding small features  | 25 |
-| Level3  | GSSOC New features, major bug fixing.  | 45 |
+| Difficulty | Intent                                  | Score |
+| ---------- | --------------------------------------- | ----- |
+| Level0     | GSSOC Minor Documentation               | 5     |
+| Level1     | GSSOC Major Documentation               | 10    |
+| Level2     | GSSOC Bug fixing, adding small features | 25    |
+| Level3     | GSSOC New features, major bug fixing.   | 45    |
 
 #### Allotment:
 
 - Add labels to PRs [ Must add `gssoc21` label]
-