Tech Tracker

How to run:

Clone the Repository & Install Dependencies

git clone https://git.gbrown.org/gib/techtracker.git

cd techtracker

I would recommend using bun to install dependencies.

bun i

You will also need docker installed on whatever host you plan to run the Convex instance from, whether locally, or on a home server or a VPS or whatever. Or you can just use the Convex SaaS if you want to have a much easier time, probably. I wouldn't know!

Add your environment variables

Copy the example environment variable files and paste them in the same directory named .env.

Environment variables for Next Application

cp ./apps/next/env.example ./apps/next/.env

Environment variables for Self Hosting Convex & Website with Docker

cp ./docker/env.example ./docker/.env

Start self hosted convex & Next Web Application

The basic gist is to run the commands below after you have filled out the environment variables you plan to use, but you should ultimately follow the guide they provide

cd ./docker
sudo docker compose up -d
sudo docker compose exec convex-backend ./generate_admin_key.sh

Start your development environment.

Run

bun dev

Fin

I am sure I am missing a lot of stuff so feel free to open an issue if you have any questions or if you feel that I should add something here!

1.7 KiB Raw Blame History