diff --git a/README.md b/README.md index be2277c..fa7d80f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,15 @@ ![SRIJAS_LOGO](https://user-images.githubusercontent.com/40118578/135184051-73acf9be-07c1-4c98-9730-68fa161f6a1b.png) - - [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![Github](https://img.shields.io/badge/language-python-red.svg) -![GitHub issues](https://img.shields.io/github/issues-raw/ineelshah/SRIJAS) -![Github closes issues](https://img.shields.io/github/issues-closed-raw/ineelshah/SRIJAS) -![Github pull requests](https://img.shields.io/github/issues-pr/ineelshah/SRIJAS) -![Github closed pull requests](https://img.shields.io/github/issues-pr-closed/ineelshah/SRIJAS) +![GitHub issues](https://img.shields.io/github/issues-raw/hvudeshi/SRIJAS) +![Github closes issues](https://img.shields.io/github/issues-closed-raw/hvudeshi/SRIJAS) +![Github pull requests](https://img.shields.io/github/issues-pr/hvudeshi/SRIJAS) +![Github closed pull requests](https://img.shields.io/github/issues-pr-closed/hvudeshi/SRIJAS) [![DOI](https://zenodo.org/badge/408230160.svg)](https://zenodo.org/badge/latestdoi/408230160) [![Build Status](https://app.travis-ci.com/ineelshah/SRIJAS.svg?branch=main)](https://app.travis-ci.com/ineelshah/SRIJAS) [![codecov](https://codecov.io/gh/ineelshah/SRIJAS/branch/main/graph/badge.svg?token=Z9MGKKAXN6)](https://codecov.io/gh/ineelshah/SRIJAS) -![version](https://img.shields.io/badge/version-1.0-blue) +![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/hvudeshi/SRIJAS) ![github workflow](https://github.com/ineelshah/SRIJAS/actions/workflows/unit_test.yml/badge.svg) ![github workflow](https://github.com/ineelshah/SRIJAS/actions/workflows/style_checker.yml/badge.svg) ![github workflow](https://github.com/ineelshah/SRIJAS/actions/workflows/main.yml/badge.svg) @@ -19,14 +17,12 @@ ![github workflow](https://github.com/ineelshah/SRIJAS/actions/workflows/code_cov.yml/badge.svg) ![github workflow](https://github.com/ineelshah/SRIJAS/actions/workflows/close_as_a_feature.yml/badge.svg) ![github workflow](https://github.com/ineelshah/SRIJAS/actions/workflows/Respost.yml/badge.svg) - +![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/hvudeshi/SRIJAS) +![Lines of code](https://img.shields.io/tokei/lines/github/hvudeshi/SRIJAS) +![GitHub contributors](https://img.shields.io/github/contributors/hvudeshi/SRIJAS) https://user-images.githubusercontent.com/25223347/135366127-f6b741f2-de85-4d64-92c9-cd1d2f518090.mp4 - - - - # S.R.I.J.A.S. ## Job Search was never this easy Smart-Resume-Interpreter-And-Job-Alert-System is an application that makes your job search easy and less frustrating. @@ -97,6 +93,13 @@ This is our submission for the Project for Software Engineering CSC 510 Fall 202 - [ ] Allow users to generate insights from how the uploaded resume compares with job descriptions in the market. - [ ] Generate insights from all collected data. +## Report Bug or Request a feature +

+ Report Bug + · + Request Feature +

+ 🔱: Installation --- 1. Clone the Github repository to a desired location on your computer. You will need [git](https://git-scm.com/) to be preinstalled on your machine. Once the repository is cloned, you will then ```cd``` into the local repository. @@ -109,15 +112,14 @@ cd SRIJAS pip install -r requirements.txt ``` -Contributors ---- +## Contributors (Phase-2) + - - - - - + + + + +

Neel Shah

Parth Patel


Ameya Tathavadkar


Jay Shah


Harshil Shah


Het Patel

Hardik Udeshi


Saloni Mahatma


Kalgee Kotak


Vineet Chheda

- diff --git a/docs/proj2rubric.md b/docs/proj2rubric.md new file mode 100644 index 0000000..8064fd6 --- /dev/null +++ b/docs/proj2rubric.md @@ -0,0 +1,28 @@ +# Project-2 Rubric + +|Score|Notes| Evidence| +|-|-----|---------| +|.5| short release cycles| https://github.com/hvudeshi/SRIJAS/releases | +|.5| workload is spread over the whole team (so one team member is often Xtimes more productive than the others...| https://github.com/hvudeshi/SRIJAS/graphs/contributors | +|.5|Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing | The demo video and repository homepage (README) shows this (https://github.com/hvudeshi/SRIJAS/blob/main/README.md) | +|.5|the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up | https://github.com/hvudeshi/SRIJAS/blob/main/CONTRIBUTING.md | +|.5|Docs: doco generated , format not ugly | in GH(https://github.com/hvudeshi/SRIJAS/blob/main/docs/Scraper_Service_linked-in_documentation.pdf) | +|.5|evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) | https://github.com/hvudeshi/SRIJAS/graphs/contributors | +|.5|evidence that the members of the team are working across multiple places in the code base | https://github.com/hvudeshi/SRIJAS/graphs/contributors | +|1|Docs: what: point descriptions of each class/function (in isolation) | https://github.com/hvudeshi/SRIJAS/blob/main/docs | +|.5|Number of commits: by different people | in GH (https://github.com/hvudeshi/SRIJAS/commits/main) | +|1|issues are being closed | evidence in GH(https://github.com/hvudeshi/SRIJAS/issues?q=is%3Aissue+is%3Aclosed) | +|.5|issues are discussed before they are closed | After implementation of every issues, there's been validation based on whether the issue is properly working or not. Additionally, all the dependencies based on that issue is discussed and checked if all the functionalities are working fine. For eg. 1. Login System was added to the project to maintain and track the record of every user. After, implmenting all the necessary dependencies were checked such as new attributes are added to the database tables, main index.html file and other dependent on that are updated, etc. | +|.5|Use of syntax checkers. | https://github.com/hvudeshi/SRIJAS/blob/main/.github/workflows/main.yml | +|1|Issues reports: there are many | https://github.com/hvudeshi/SRIJAS/issues | +|.5|Use of code formatters. | https://github.com/hvudeshi/SRIJAS/blob/main/.github/workflows/code_formatter.yml | +|.5|Use of style checkers | https://github.com/hvudeshi/SRIJAS/blob/main/.github/workflows/style_checker.yml | +|.5|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. | https://github.com/hvudeshi/SRIJAS/blob/main/README.md | +|.5|test cases exist | a lot of test cases exist covering almost all the functionalities. (https://github.com/hvudeshi/SRIJAS/blob/main/tests/keyword_extraction_modules_test.py) | +|.5|Use of code coverage | https://github.com/hvudeshi/SRIJAS/blob/main/.github/workflows/code_cov.yml | +|.5|other automated analysis tools | There are two additional automated analysis tools 1. Close as a feature (https://github.com/hvudeshi/SRIJAS/blob/main/.github/workflows/close_as_a_feature.yml) 2. Respost- adding comment to new issue events (https://github.com/hvudeshi/SRIJAS/blob/main/.github/workflows/Respost.yml) | +|.5|test cases:.a large proportion of the issues related to handling failing cases. | if a test case fails, open an issue and fix it, evidence( Add example) | +|.5|test cases are routinely executed | Github actions and travis CI both are conducting regular tests. (https://github.com/hvudeshi/SRIJAS/blob/main/.travis.yml) | +|1|Documentation describing how this version improves on the older version| (Add) | +|3|This version is a little(1), some(2), much(3) improved on the last version.| (Add) | +|16| Total|