Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 5.2 KB

README.md

File metadata and controls

69 lines (46 loc) · 5.2 KB

NC State Jobs Review System

DOI License GitHub Release code-coverage Build GitHub contributors Open Issues Closed issues Pull Requests Code style: black linting: pylint

This is a Flask App for NCSU Campus Job Review System with SQL database for storage. Here students from NCSU can view reviews on all different jobs that are available on campus. The aim of the portal is to help students get a closer understanding of the job description and the work, as experienced by fellow students. The website allows the students to upload reviews for others to view. The anonymity of the students is maintained to let them upload honest reviews.

alt text

Pre-requisites

To run these scripts, you will require Python installed on your PC. Please visit Python Installers to download the lastest python version. Apart from that, other requirements can be installed with the help of requirements.txt.

Installation

Initially you can check whether your system has python pre-installed or not, usually nowadays in most of the systems, be it Windows or MacOS, python is pre-installed.

To check whether you have python installed or not, you can open CMD or a Terminal and run the command "python --version". If the CMD shows the version such as Python 3.6.7 then your system already has python installed and you just need to clone the repository and run the python scripts.

If this is not the case, then you need to download python installer package from Python Installers based on your system's operating system and install it and you can further clone this repository to execute the scripts.

You can refer INSTALL.md for the complete installation steps based on your OS.

Demo Video

project2-demo.mp4

Poster for Stage 1

alt text

Contribution Code of Conduct

The rules listed below are to be followed by the ones who will be contributing to the code in the repository:

  • All the branches used to merge any code into the main branch should start with "KAPSS-".
  • Atleast one review/approval is required from any other contributors of the project to merge a commit to the main branch.
  • It is recommended to delete the branch as soon as it is merged to the main branch to avoid stale branches in the repository.
  • It is encouraged to add name tags such as "feature-" or "patch-" in the branches if it is used to add code-patches or features in the project.

Code Coverage Screenshot

alt text

Chat Channel Screenshot

alt text

Deployment

We have deployed our website here

Contributors