Issue Tracker 2024

Issue tracker hobby project

Inspiration: "The 1 Coding Project Idea Guaranteed To Get You A Software Development Job" by Coder Foundry

How to get started

1. Clone this repo.
2. Install Node.js
3. Install pnpm
4. Install PostgreSQL
5. Create the issue-tracker-2024 database
6. And then create issues table using the provided script (create-issues-table.sql)
7. You will need to configure the following environment variables for this app, depending on how you setup your PostgreSQL install. At minimum you will need to add PG_USER and PG_PASS to the frontend/.env file.

PG_HOST defaults to 127.0.0.1
PG_PORT defaults to 5432
PG_DATABASE defaults to issue-tracker-2024
PG_USER defaults to undefined
PG_PASS defaults to undefined
PG_SSL defaults to true

5. Run the following commands

pnpm install
pnpm run dev

6. Open http://localhost:3000 in your browser.

API Endpoints

The backend supplies the following API endpoints

• GET /healthCheck always returns OK
• GET /issue/list returns a list of the issues
• GET /issue/{slug} returns a specific issue
• POST /issue/new create a new issue
• POST /issue/{slug} update an existing issue
• DELETE /issue/{slug} delete an issue

Other backend implementations

By default the app will directly connect to a PostgreSQL database using the Next.js API routes.

However you can configure the ISSUE_API_URL environment variable to use some other backend implementations that are provided in this repo:

• AWS Lambda + DynamoDB + Node.js
• AWS Lambda + DynamoDB + Rust
• GCP Cloud Functions + PostgreSQL + Go

All of the above implement the same API routes and function interchangeably.

Tools/Technologies used for this project

• nvm
• nodejs
• pnpm
• nx
• nextjs
• tailwindcss
• typescript
• tsup
• postgresql
• beekeeper studio (homebrew)
• knex
• golang
• google cloud run
• firebase
• rust
• cargo lambda
• aws lambda
• aws dynamodb