Tickflo is an open-source business toolkit designed to streamline workflows and enhance productivity. Built with ❤️ using React Router, it provides a modern, user-friendly interface with seamless back-end integration.
Before setting up the project, ensure you have the following installed:
- Node.js
- pnpm (recommended package manager)
- Docker (for database services)
1 Install pnpm if you haven't already:
npm install -g pnpm- Install project dependencies:
pnpm install- Copy the default environment variables:
cp .env.example .env- Start the PostgreSQL database using Docker Compose:
docker compose up -d- Start the development server with Hot Module Replacement (HMR):
pnpm devYour application will be available at http://localhost:3000.
To create an optimized production build:
pnpm buildTo start the production server:
pnpm startA prebuilt Docker image is available on GitHub Container Registry (GHCR).
name: tickflo
services:
app:
image: ghcr.io/tickflo/tickflo:master
container_name: tickflo-app
restart: unless-stopped
ports:
- "3000:3000"
environment:
POSTGRES_HOST: tickflo-db
POSTGRES_USER: tickflo
POSTGRES_PASSWORD: password
POSTGRES_DB: tickflo
BASE_URL: http://localhost:3000
depends_on:
- db
db:
image: "postgres:17.2-bookworm"
container_name: tickflo-db
restart: unless-stopped
ports:
- "5432:5432"
environment:
POSTGRES_USER: tickflo
POSTGRES_PASSWORD: password
POSTGRES_DB: tickfloTickflo is released under the AGPLv3 License.
Contributions are welcome! Feel free to submit issues or pull requests to help improve Tickflo.