Skip to content

Latest commit

 

History

History
89 lines (55 loc) · 2.21 KB

README.md

File metadata and controls

89 lines (55 loc) · 2.21 KB
Raw

Skill Check

A single page application for visualising the market value of software skills.

Available at skill-check.herokuapp.com

Update: Upon reflection, this app is potentially susceptible to SQL injections, the site will be down until I decide to fix these.

Preview

text

Features

  • Visualisations for a variety of programming languages & skills of:
    • Distribution of salaries
    • Number of job postings for that skill
    • Timeseries for plotting trends in skill salaries
  • The ability to quickly select a number of pre-existing search queries, or to easily assemble new queries

Utilises:

  • A React frontend with appropriate utilisation of components and hooks
  • PostgreSQL database, populated from the Reed job search API, in combination with Cheerio webscraping
  • Hosts a RESTful API (using Express) to allow the client to dynamically and easily query the database for job skills
  • Bundled with Vite for production and development with hot module replacement
  • Specific frontend features include: Chart JS, lazy image loading, and reponsive design for desktop, mobile, tablet etc.

Instructions:

Hosting

  • Install Node.js

  • Clone this repoistory

  • Install: npm install .

  • For production run:

npm run build
npm run start
  • For development run (in separate terminals):
npm run dev
npm run serve

Database pipeline (local)

  • Install PostgreSQL

  • Create a database called skillcheck

  • Set the .env variables (see below)

  • Execute the scripts from populate-database (future versions will automate this):

  1. node /populate-database/api-urls.js

  2. node /populate-database/scrape-postings.js

  3. node /populate-database/populate-databse.js

.ENV

The following env variables are required for hosting

PGHOST=[your postgres database]
PGUSER=[your postgres username]
PGDATABASE=skillcheck
PGPASSWORD=[your postgres password]
PGPORT=[your postgres port]

PORT=[your optional express port]

And for accessing the Reed API

API_KEY=[your reed API key]