Contributing

Development Setup

Get your local environment ready to contribute to TLD.

Prerequisites

ToolVersion
Go1.21+
Node.js18+
Python3.11+
Docker24+

Clone the repository

bash
$ git clone https://github.com/thelastdeploy/thelastdeploy.git
$ cd thelastdeploy

Build the CLI

bash
$ make build # builds to ./bin/tld
$ make install # builds + installs to /usr/local/bin
$ ./bin/tld version # verify

Run the backend

bash
$ cd web/backend
$ python -m venv venv && source venv/bin/activate
$ pip install -r requirements.txt
$ uvicorn main:app --reload
# API running at http://localhost:8000

Run the frontend

bash
$ cd web/frontend
$ npm install && npm run dev
# Dashboard running at http://localhost:3000
 
# For the landing page and docs:
$ cd landing
$ npm install && npm run dev
# Landing at http://localhost:3002
# Docs at http://localhost:3002/docs