Development

This guide covers how you can work on Invio on your local machine. I have tested this on both the latest version of windows 11, and the latest version of linux (CachyOS). I have no solid way to run a test docker build yet, planned for the future though.

Local Dev Server

Prerequisites:

Required

• Bun installed on system
• Deno installed on system

Handy

• To generate PDFS you will need to install WeasyPrint on your sytem

Step 1

Clone the repository on your local machine. (if you haven't already)

git clone https://github.com/kittendevv/Invio.git && cd Invio

Step 2

Create .env file in the /backend directory.

ADMIN_USER=admin
ADMIN_PASS=admin
JWT_SECRET=change-me-in-production

Create .env file in the /frontend directory.

ORIGIN=http://localhost:8000

Step 3

Install dependencies

cd frontend && bun install

cd backend && deno install

Step 4

Start backend and frontend

cd frontend && bun dev

cd backend && deno task dev

Step 5

Visit http://localhost:5173 (if you set a different port this might be different for you)

docker-compose-dev.yml

Prerequisites:

Required

• Docker installed on system
• Docker Compose Plugin installed on system

Step 1

Clone the repository on your local machine. (if you haven't already)

git clone https://github.com/kittendevv/Invio.git && cd Invio

Step 2

Create .env file in the root directory.

ADMIN_USER=admin
ADMIN_PASS=admin
ORIGIN=http://localhost:8000
JWT_SECRET=change-me-in-production

Step 3

Spin up the docker container from docker-compose-dev.yml (the only difference with the normal compose file is that it builds locally)

docker compose -f docker-compose-dev.yml up --build