forked from nehajaideep/WolfTrack3.0
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from aniketdarp190301/reccomended_jobs
Implemented prototype for recommended jobs page
- Loading branch information
Showing
3 changed files
with
184 additions
and
897 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <h1><b>WolfTrack 3.0</b></h1> | ||
| <h1><b>WolfTrack </b></h1> | ||
|
|
||
| [Demo Link](https://drive.google.com/file/d/1Ug-K1hOt9Jbbztuziw2OZFPyBx66PqLx/view?usp=sharing) <br> | ||
| [WolfTrack 3.0 Youtube](https://youtu.be/3_JZxAd9lcs) | ||
|
|
@@ -20,11 +20,12 @@ | |
|                       <img width = "380" height = "450" src = "static/images/wolftrack3.0.png"> </img> | ||
|
|
||
| --- | ||
|
|
||
| # ❓ Why WolfTrack3.0 ❓ | ||
|
|
||
| Do you find yourself applying to too many companies and losing track of your time? | ||
| Do you find yourself applying to too many companies and losing track of your time? | ||
|
|
||
| Do you want to hear from your coworkers or experts? | ||
| Do you want to hear from your coworkers or experts? | ||
|
|
||
| WolfTrack 3.0 aids in the planning and organization of job applications in a chronological manner so that you can conveniently track job applications, receive professional advice, and land your dream job. We keep track of job applications, job descriptions, locations, wages, dates, and notes, among other things. | ||
|
|
||
|
|
@@ -33,16 +34,15 @@ WolfTrack 3.0 aids in the planning and organization of job applications in a chr | |
| **So, let's go get that job! 😎** | ||
|
|
||
| --- | ||
| ## 🥊 Punch Line | ||
|
|
||
| ## 🥊 Punch Line | ||
|
|
||
| https://user-images.githubusercontent.com/66715000/144538638-acc75fa1-db5b-49a1-a5d0-9b3bbc79cf89.mp4 | ||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## 📚 Technology Stack | ||
|
|
||
|             <code><a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5" target="_blank"><img src = "https://upload.wikimedia.org/wikipedia/commons/c/c3/Python-logo-notext.svg" width="50"/></a></code> | ||
| <code><a href="https://flask.palletsprojects.com/en/1.1.x/" target="_blank"><img height="50" src="https://freetutsdownload.net/wp-content/uploads/2021/07/Learn-Flask-A-web-Development-Framework-of-Python.jpg"></a></code> | ||
| <code><a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5" target="_blank"><img height="50" src="https://cdn.pixabay.com/photo/2017/08/05/11/16/logo-2582748_1280.png"></a></code> | ||
|
|
@@ -52,116 +52,131 @@ https://user-images.githubusercontent.com/66715000/144538638-acc75fa1-db5b-49a1- | |
| <code><a href="https://www.mysql.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/mysql/mysql-ar21.svg"></a></code> | ||
| <code><a href="https://aws.amazon.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/amazon_aws/amazon_aws-ar21.svg"></a></code> | ||
|
|
||
| <p align="center"> Python | Flask | HTML | CSS | JavaScript | BootStrap | MySQL | AWS </p> | ||
| <p align="center"> Python | Flask | HTML | CSS | JavaScript | BootStrap | MySQL | AWS </p> | ||
|
|
||
| ## 🎛️ Version Control Tools | ||
|
|
||
| <p align="center"> | ||
| <img src="https://i.giphy.com/media/KzJkzjggfGN5Py6nkT/200.webp" width="150"><img src="https://i.giphy.com/media/IdyAQJVN2kVPNUrojM/200.webp" width="150"> <img src="https://media.giphy.com/media/UWt0rhp21JgLwoeFQP/giphy.gif" width ="150"/> <img src="https://media.giphy.com/media/kH6CqYiquZawmU1HI6/giphy.gif" width ="150"/> | ||
| </p> | ||
|
|
||
| ## 🧰 Tools | ||
|
|
||
|               | ||
|
|
||
| - #### We have created an entire CI pipeline which includes all the stages including Code Analysis, Style checkers, Code Coverage, Code Assemble and Docker Image Build, readily available to run the image on any server without manually setting up the environment. | ||
| - #### We have created an entire CI pipeline which includes all the stages including Code Analysis, Style checkers, Code Coverage, Code Assemble and Docker Image Build, readily available to run the image on any server without manually setting up the environment. | ||
| - [Github WorkFlow YAML](https://github.com/nehajaideep/WolfTrack3.0/blob/Group10StableBranch/.github/workflows/main.yml) | [Dockerfile](https://github.com/nehajaideep/WolfTrack3.0/blob/Group10StableBranch/Dockerfile) | [Prettier Code Formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [JS-HTML-CSS Formatter](https://marketplace.visualstudio.com/items?itemName=lonefy.vscode-JS-CSS-HTML-formatter) | [Flake8](https://github.com/nehajaideep/WolfTrack23.0/blob/Group10StableBranch/.github/workflows/main.yml) | ||
|
|
||
| ### Third-Party Tools | ||
|
|
||
| - [AWS Relational Database Service-RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html) | ||
| - The AWS Database is used as a primary DB by the location. The application interacts with the DB and no additional steps are required from the users. For any contributors or future developers, please mail to [email protected] to get your AWS IAM user account details to connect to AWS RDS. | ||
| - The AWS Database is used as a primary DB by the location. The application interacts with the DB and no additional steps are required from the users. For any contributors or future developers, please mail to [email protected] to get your AWS IAM user account details to connect to AWS RDS. | ||
| - [Microsft Power BI](https://docs.microsoft.com/en-us/power-bi/) | ||
| - [Highcharts](https://www.highcharts.com/) | ||
|
|
||
| --- | ||
|
|
||
| ## 💻 Getting Started & Installation: | ||
|
|
||
| - ### Prerequisite: | ||
| - Download [Python3.x](https://www.python.org/downloads/). | ||
| - ### Prerequisite: | ||
|
|
||
| - Download [Python3.x](https://www.python.org/downloads/). | ||
|
|
||
| - ### Installation: | ||
|
|
||
| E.g If you downloaded `Python 3.8.7` above, then | ||
|
|
||
| **Steps to setup virtual environment** | ||
|
|
||
| - Create a virtual environment: | ||
|
|
||
| `python3.8 -m venv test_env` | ||
|
|
||
| - Activate the virtual environment: | ||
|
|
||
| `source test_env/bin/activate` | ||
|
|
||
| - Build the virtual environment:(must be present in [project root directory](https://github.com/nehajaideep/WolfTrack2.0)) | ||
|
|
||
| - ### Installation: | ||
| E.g If you downloaded `Python 3.8.7` above, then | ||
| `pip install -r requirements.txt` | ||
|
|
||
| **Steps to setup virtual environment** | ||
| - Create a virtual environment: | ||
| - ### Run Instructions | ||
|
|
||
| `python3.8 -m venv test_env` | ||
|
|
||
| - Activate the virtual environment: | ||
| **To run/test the site locally:** | ||
|
|
||
| `source test_env/bin/activate` | ||
|
|
||
| - Build the virtual environment:(must be present in [project root directory](https://github.com/nehajaideep/WolfTrack2.0)) | ||
| - Clone [WolfTrack github repo](https://github.com/nehajaideep/WolfTrack2.0). | ||
|
|
||
| `pip install -r requirements.txt` | ||
| - Navigate to [project directory](https://github.com/nehajaideep/WolfTrack2.0). | ||
|
|
||
| - ### Run Instructions | ||
| - Run `python main.py` or `python3 main.py` <br> <br> | ||
| If there is a certificate error coming up for nltk stopwords download: <br> | ||
|
|
||
| **To run/test the site locally:** | ||
| - search for "Install Certificates.command" in finder and open it. Its a script that will install required Certificates. <br> | ||
| - Run the above command again. | ||
|
|
||
| - Clone [WolfTrack github repo](https://github.com/nehajaideep/WolfTrack2.0). | ||
| - Site will be hosted at: | ||
| `http://127.0.0.1:5000/` | ||
|
|
||
| - Navigate to [project directory](https://github.com/nehajaideep/WolfTrack2.0). | ||
|
|
||
| - Run `python main.py` or `python3 main.py` <br> <br> | ||
| If there is a certificate error coming up for nltk stopwords download: <br> | ||
| - search for "Install Certificates.command" in finder and open it. Its a script that will install required Certificates. <br> | ||
| - Run the above command again. | ||
| - ### Application Deployed on a sandbox server | ||
| - You can access the application on the url | ||
| `https://harshb.pythonanywhere.com/login` | ||
|
|
||
| ## 🚢 Run locally using Docker | ||
|
|
||
| - Site will be hosted at: | ||
| `http://127.0.0.1:5000/` | ||
|
|
||
| - ### Application Deployed on a sandbox server | ||
| - You can access the application on the url | ||
| `https://harshb.pythonanywhere.com/login` | ||
|
|
||
| ## 🚢 Run locally using Docker | ||
| Our application is docker-compatible configured and you have to follow below steps to run the docker on local:<br> | ||
| Note : Make sure you have a docker desktop or docker client installed on your system | ||
| * [Docker Desktop Installation Guide](https://docs.docker.com/get-docker/) | ||
|
|
||
| - [Docker Desktop Installation Guide](https://docs.docker.com/get-docker/) | ||
|
|
||
| 1. Clone the repository | ||
|
|
||
| ``` | ||
| git clone https://github.com/nehajaideep/WolfTrack3.0.git | ||
| ``` | ||
|
|
||
| 2. Go the the repository | ||
|
|
||
| ``` | ||
| cd WolfTrack3.0 | ||
| ``` | ||
|
|
||
| 3. Run the docker build command | ||
|
|
||
| ``` | ||
| docker build --tag wolftrackv3:1.0 . | ||
| ``` | ||
|
|
||
| 4. Run the built docker image on local Container | ||
|
|
||
| ``` | ||
| docker run -dp 5000:5000 wolftrackv3:1.0 | ||
| ``` | ||
|
|
||
| 5. Test the backend application using below api | ||
|
|
||
| ``` | ||
| GET localhost:5000/login | ||
| Response :- "Login Page will appear" | ||
| ``` | ||
|
|
||
| 6. Tag the Deployable image | ||
|
|
||
| ``` | ||
| docker tag wolftrackv2:1.4 akhil/wolftrackv3:1.0 | ||
| ``` | ||
|
|
||
| 7. Push the Deployable tagged image to the DockerHub Cloud Image Repository | ||
|
|
||
| ``` | ||
| docker push akhil/wolftrackv3:1.0 | ||
| ``` | ||
|
|
||
| 8. Below DockerHub Repository where the readily deployable Image is available | ||
| <img width="1389" alt="Screenshot 2021-11-04 at 9 38 50 PM" src="https://user-images.githubusercontent.com/32817064/140444016-f26825a8-6fb6-4345-ab6a-54986163ede5.png"> | ||
| <img width="1389" alt="Screenshot 2021-11-04 at 9 38 50 PM" src="https://user-images.githubusercontent.com/32817064/140444016-f26825a8-6fb6-4345-ab6a-54986163ede5.png"> | ||
|
|
||
| --- | ||
|
|
||
| [Class/Functions Documentation](https://github.com/nehajaideep/WolfTrack3.0/blob/Group10StableBranch/docs/WolfTrack3.0_Documentation.pdf) | ||
| [Class/Functions Documentation](https://github.com/nehajaideep/WolfTrack3.0/blob/Group10StableBranch/docs/WolfTrack3.0_Documentation.pdf) | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -170,6 +185,7 @@ docker push akhil/wolftrackv3:1.0 | |
| It is part of the [Github Workflow Build](https://github.com/nehajaideep/WolfTrack2.0/runs/4099439944?check_suite_focus=true) | ||
|
|
||
| --- | ||
|
|
||
| ## 🛤️ Roadmap | ||
|
|
||
| ### Phase 1 WolfTrack: | ||
|
|
@@ -191,26 +207,25 @@ It is part of the [Github Workflow Build](https://github.com/nehajaideep/WolfTra | |
| - [x] Upload and maintaining resume versions | ||
| - [x] Send remainder mails for deadlines | ||
| - [x] Share your profile with others | ||
| - [x] Creation of Docker image | ||
| - [x] Creation of Docker image | ||
| - [x] Readily deployable image in docker registry | ||
|
|
||
|
|
||
| ### 🏁 Phase 3 WolfTrack 3.0: | ||
|
|
||
| ☑️ Two Type Login Application - Admin and User.<br> | ||
| ☑️ Resume Review, Comment, Download and Like by Admin. | ||
| ☑️ Comments given by Admin are sent as email to the user. <br> | ||
| ☑️ Cronjob for pending application deadlines as email notification. <br> | ||
| ☑️ Implemented web scraping to find relevant jobs according to user's profile and recommend him <br> | ||
| ☑️ Daily Goal Check to keep track of number of jobs applied and to apply <br> | ||
| ☑️ Customizable Daily Target Field <br> | ||
| ☑️ Parse Resume Document with other extensions <br> | ||
| ☑️ Recommend jobs by matching the resume with open jobs <br> | ||
| ☑️ Two Type Login Application - Admin and User.<br> | ||
| ☑️ Resume Review, Comment, Download and Like by Admin. | ||
| ☑️ Comments given by Admin are sent as email to the user. <br> | ||
| ☑️ Cronjob for pending application deadlines as email notification. <br> | ||
| ☑️ Implemented web scraping to find relevant jobs according to user's profile and recommend him <br> | ||
| ☑️ Daily Goal Check to keep track of number of jobs applied and to apply <br> | ||
| ☑️ Customizable Daily Target Field <br> | ||
| ☑️ Parse Resume Document with other extensions <br> | ||
| ☑️ Recommend jobs by matching the resume with open jobs <br> | ||
|
|
||
| ### 🔭 Phase 4 WolfTrack 4.0 (Future Scope): | ||
|
|
||
| - [ ] Configure Cron-Job for reminder as SMS notification | ||
| - [ ] Model improvement of resume analyzer | ||
| - [ ] Model improvement of resume analyzer | ||
| - [ ] Customization of job recommendations | ||
| - [ ] Direct application links to jobs in the recommendation list | ||
| - [ ] Online chat with expert | ||
|
|
@@ -219,6 +234,7 @@ It is part of the [Github Workflow Build](https://github.com/nehajaideep/WolfTra | |
| --- | ||
|
|
||
| ## ✍️ Contributions | ||
|
|
||
| Please refer to the [CONTRIBUTING.md](https://github.com/nehajaideep/WolfTrack2.0/blob/Group10StableBranch/CONTRIBUTING.md) if you want to contrbute to the Wolftrack 3.0 source code. Follow all the guidelines mentioned and raise a pull request for the developers to review before the code goes to the main source code. | ||
|
|
||
| --- | ||
|
|
||
Oops, something went wrong.