Getting started

Luckee is for solo founders and owner-operators who run sales and delivery without a back office: leads, email, contacts, customers, projects, tickets, and time in one stack. This page is the starting point for self-hosting — run the web app and the Express API locally so they talk to each other.

What you are running

Self-hosted Luckee is two repositories: a Next.js front end (TypeScript, Redux for client state) and an Express API for business logic, persistence, and integrations. You will clone both, configure environment variables (Supabase, API base URL, and anything else each README calls out), and keep both processes running while you develop.

After sign-in, the dashboard and sidebar surface the tools you use day to day (Leads and more). How the product behaves is documented here; commands and env live in each repo's README on GitHub.

Follow the READMEs in order

Use the GitHub README as the source of truth for commands, ports, and env files. Work through the web app README first, then the Express server README so environment variables and local URLs line up.

  • Web (Next.js + Redux): trouthouse-tech/luckee-open-source — README covers .env.local, NEXT_PUBLIC_API_URL, and npm run dev.
  • API (Express): follow the README in your Express repository (public GitHub link coming soon). — install, env, database or services, and how to start the server.

Goal: both repos running locally

You are done with setup when the Express API is up on the host and port from its README, the Next.js app is running (typically localhost:3000), and the web app successfully calls the API using the base URL you configured. Fix any CORS or auth issues using the guidance in those READMEs.

Suggested first steps

  1. Clone luckee-open-source and complete its README (dependencies, env, dev server).
  2. Clone the Express API repo and complete its README so the API listens locally.
  3. Point the web app at your local API (see web README for NEXT_PUBLIC_API_URL and related vars).
  4. Sign in and confirm the dashboard loads against your local stack.
  5. Read the Leads guide for how lead workflows fit together end to end.

Where to go next