Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 2.26 KB

README.md

File metadata and controls

86 lines (59 loc) · 2.26 KB
Raw

LOAN WOLF

Track loan payments like you're on the hunt!

https://loan-wolf.r7.cx

About

Loan Wolf is a simple loan tracker that allows you to create loans and manage payments. It's built with Remix, Prisma, and Mantine.

Create a shareable loan that only you can manage with basic password protection.

Running Loan Wolf

Docker

To run the application yourself, I recommend using Docker:

docker run -d -p 3000:3000 ghcr.io/ryan-willis/loan-wolf:latest

Then visit http://localhost:3000 in your browser.

Docker Compose

You can also use Docker Compose (if you've checked out the repo):

docker-compose up -d

Here's a minimal configuration for docker-compose.yml:

services:
  loan-wolf:
    image: ghcr.io/ryan-willis/loan-wolf:latest
    ports:
      - 3000:3000

The SQLite database will be stored in a volume at /data/loan-wolf within the container so data will persist between container restarts. You can add your own volume to the loan-wolf service to persist the data on the host machine:

docker run -d -p 3000:3000 -v ~/.loan-wolf:/data/loan-wolf ghcr.io/ryan-willis/loan-wolf:latest
volumes:
  loan_wolf:
services:
  loan-wolf:
    image: ghcr.io/ryan-willis/loan-wolf:latest
    ports:
      - 3000:3000
    volumes:
      - loan_wolf:/data/loan-wolf

Environment Variables

If any of the _SECRET environment variables are not specified, randomly generated values will be placed in the /data/loan-wolf directory when the container is first run. (If you're running the built application locally, these files will be placed in the operating system's temporary directory.)

  • SESSION_SECRET
    • A secure string for signing session cookies.
  • PASSWORD_SECRET
    • A secure string for hashing passwords in the database (uses argon2 under the hood).
  • DATABASE_URL
    • The connection string for the SQLite database (defaults to file:/data/loan-wolf/sqlite3.db).

Local Development

Run the Vite dev server (full stack):

npm run dev