Testfuel

Testfuel is an open source test case management system for software development teams. Organize test suites, track releases, and collaborate with your team in workspaces and projects.

• Workspaces — Team spaces with member access and multiple projects
• Projects — Group test suites and releases by product or service
• Releases — Define releases and associate test suites for test runs
• Suites — Organize test cases into suites; support for archiving
• Test cases — Create and manage individual test cases within suites
• Authentication — JWT-based auth with email verification
• Multi-tenant — Workspace-based isolation and access control

• Client: React 18, TypeScript, Redux Toolkit, TanStack Query, React Router, Ant Design, Tailwind CSS
• Server: NestJS 8, TypeScript, TypeORM, PostgreSQL, Passport JWT, Nodemailer
• Landing: Next.js, React, SASS, Framer Motion

• Node.js (v16+)
• PostgreSQL (for the API)
• npm or yarn

Start PostgreSQL separately (lives outside this repo at ~/Projects/postgres), then run the app:

~/Projects/postgres/start.sh
docker compose --env-file .env up --build

Copy .env.example to .env and set your database credentials.

Services:

PostgreSQL is managed in a separate project (~/Projects/postgres). Each app connects with its own database/user on that shared instance.

PostgreSQL must already be running on the server (see ~/Projects/postgres).

Manual deploy from the revamp branch (no merge to main required yet):

1. One-time server setup

   git clone -b revamp https://github.com/<org>/testfuel.git ~/testfuel
   cd ~/testfuel
   cp .env.production.example .env.production
   # Edit .env.production with production secrets (DB, SECRET_KEY, etc.)

2. GitHub repository secrets (Settings → Secrets and variables → Actions)

   Secret	Example
   PRODUCTION_HOST	155.133.27.10
   PRODUCTION_USER	root
   PRODUCTION_SSH_PRIVATE_KEY	Contents of your SSH private key
   PRODUCTION_APP_DIR	~/testfuel (optional)

3. Run deploy — Actions → Deploy to Production → Run workflow

   • Use workflow from: branch that contains this workflow (e.g. revamp)
   • Git branch to deploy to production: any branch you want on the server (e.g. revamp, main, or a feature branch)

The workflow SSHs into the production server, runs git fetch + git reset to the branch you chose, then builds and starts Docker containers on the server.

SSH_PASSWORD=your-password ./scripts/deploy.sh

Create .env.production from .env.production.example before first deploy.

git clone https://github.com/your-org/testfuel.git
cd testfuel

cd server
cp .env.example .env
# Edit .env: set SECRET_KEY, DB_STRING (or DB_HOST, DB_PORT, DB_USERNAME, DB_PASSWORD, DB_NAME), CLIENT_URL, SMTP if needed
npm install
npm run start:dev

API runs at http://localhost:3000 (or the port in your config).

cd client
npm install
# Create .env with REACT_APP_API_URL pointing to your server (e.g. http://localhost:3000)
npm run dev

App runs at http://localhost:3000 (or the port React assigns).

cd landing
npm install
npm run dev

Landing runs at http://localhost:3001 by default.

Contributions are welcome. Please open an issue or pull request on the repository.

See LICENSE in the repository.