Michael aef835fffa docs(readme): add configuration step for env and docker files
- add instructions to rename .env.example files
- add docker-compose.override.yml setup step
2026-04-29 21:49:04 +02:00
2026-04-29 20:11:57 +02:00
2026-04-29 20:11:57 +02:00
2026-04-29 20:11:57 +02:00
2026-04-29 20:11:57 +02:00
2026-04-29 20:11:57 +02:00
2026-04-29 20:11:57 +02:00

QR Code Generator

A simple QR code generator.

Features

  • Generate QR codes from URLs
  • Download as PNG or SVG
  • Track how many times each QR code was scanned

Requirements

  • Docker
  • Docker Compose
  • Make (optional, but recommended)
  • Linux (tested environment)

Configuration

Before installation, rename the example files:

  • ./app/.env.example./app/.env
  • ./app/internal/view/front/.env.example./app/internal/view/front/.env
  • ./docker-compose.override.yml.example./docker-compose.override.yml

Installation

make install

Usage

Start the project:

make watch

or

make up

Show all available commands:

make help

macOS / Windows

The project was tested on Linux.

If the Makefile does not work on your system, you can run the commands manually.

All installation steps are located in:

./.dev/.mk/system.mk

You can open this file and execute the commands step by step.

Notes

  • Make sure Docker and Docker Compose are installed and running
  • On non-Linux systems, some commands may require manual adjustment
Description
No description provided
Readme 116 KiB
Languages
Go 64.9%
TypeScript 19.9%
CSS 9.2%
Makefile 4.7%
Dockerfile 1.3%