Splitify

Split your bills with friends.

Developer Setup

This is a Laravel application with the Laravel Breeze starter kit. Follow these steps to get the application up and running:

1. Clone the Repository

2. Install Composer Dependencies:

   composer install

3. Copy the .env.example file:

   cp .env.example .env

4. Generate an Application Key:

   php artisan key:generate

5. Run Database Migrations:

   php artisan migrate

   • Choose yes to create a sqlite DB.

6. Install NPM Dependencies:

   npm install

7. Run Vite Server:

   npm run dev

8. Start the Development Server:

   composer dev

   • The application should now be accessible at http://localhost:8000.

Production Deployment

To setup Splitify in Production we provide a docker-compose.yml. We choose to not provide SSL Termination inside the splitify container to give you more flexibility. Note that you need to bring your own Reverse Proxy to properly deploy this with SSL-Certificate.

1. Download docker-compose.yml and example .env:

   wget -O docker-compose.yml https://raw.githubusercontent.com/404Simon/splitify/refs/heads/main/docker-compose.yml
   wget -O .env https://raw.githubusercontent.com/404Simon/splitify/refs/heads/main/.env.production.example

   • edit the .env file and at least change the APP_URL to your desired domain (e.g. https://splitify.example.com)

Warning

The default configuration sets APP_ENV to production. This will not allow http requests. If you want to test it locally without your reverse proxy in place, change the APP_ENV to local.

2. Generate a secret key:

   docker run --rm -v ./.env:/app/.env -w /app ghcr.io/404simon/splitify:latest php artisan key:generate

3. Create and migrate the DB:

   touch database.sqlite
   docker run --rm -v ./database.sqlite:/app/database/database.sqlite ghcr.io/404simon/splitify:latest php artisan migrate --force

4. Start application:

   docker compose up -d

If you didn't change the SERVER_NAME and port-mapping in the docker-compose.yml, the app should now be accessible on port 8080. If your reverse proxy of choice supports accessing your apps via docker networking you should use that and remove the port-mapping entirely.

Files created

• .env - Environment configuration
• database.sqlite - SQLite database file

Both files are mounted into the container and persist data.