Job Tracker

Track the progress of your job applications. This is a Code.Sydney side-project where all contributions are welcome.

About Code.Sydney

Code.Sydney is a volunteering organisation that supports beginner developers transition to paid employment whilst primarily helping non-profit and charity organisations.

Tech Stack

TypeScript
Next.js
React
TailwindCSS
Prisma
PostgreSQL

Getting Started

Cloning the Project

Click on the green <> Code button on this page and follow the instructions to clone this repository.

Install Dependencies

Installing NPM Packages

Once the project is cloned, you'll want to open the project in VS Code or a terminal.

Run the following command to install the npm dependencies.

npm install

Setting up Environment Variables

Go to the .env.example file and copy it to .env. This file will be used by Prisma to connect to your database.

Running PostgreSQL via Docker (Recommended)

Install Docker by following the instructions at: https://docs.docker.com/get-docker/

Run the development database with npm run docker-dev-start
Stop the docker containers with npm run docker-stop

By default the container's port will be bound to 5432.

Installing a PostgreSQL Database on Your Local Machine

Alternatively, you can download and install a local PostgreSQL database.

Download Link: https://www.postgresql.org/download/

Initializing the Database with Prisma

Once you have a PostgreSQL database ready, you can initialize your database by running

npx prisma migrate dev --name init

If you used a custom password, you will have to update the connection string in the .env file.

Running the Development Server

To get the development server up and running.

npm run dev

Open http://localhost:3000 with your browser to see the result.

Running Jest Tests

# run tests
npm run test

# run tests in watch mode
npm run test:watch

Database Schema

Note: A BLOB database would be better suited to store the Job Description text. But since I want to keep the project simple for the Code.Sydney members, we'll use a local PostgreSQL DB for now.