purr/README

52 lines
1.5 KiB
Plaintext

purr
-----
https://purr.eversole.co
a work-in-progress web application offering customizable password generation
and time-limited sharing of secrets.
TECH STACK
- Haskell and Scotty backend
- HTMX frontend
- SQLite database
GOALS
- Generate sufficiently memorable but secure passwords for use with accounts
that don't offer better authentication methods.
- Share text secrets with others without disclosing the secret in the
message itself.
- Provide a minimal and clean interface for generating and sharing passwords.
- Maintain a clean and organized codebase that can be extended to include more
utilities than originally anticipated.
- Be really cute compared to the competition.
WHY TRUST YOU?
You shouldn't. This is free and open-source software which you can run on your
own hardware.
DEPLOYMENT
Only Nix build instructions targeting containers are provided below,
but this project can be built and run without containers or Nix using Cabal.
- Clone this repository
- Build the container image (with flakes enabled): `nix build .#purr-container`
- Load the container image
- podman load -i result
- Use the provided docker stack example to deploy the container if desired
- docker stack deploy -c docker-stack.yml purr
DEVELOPMENT & SUPPORT
Per the permissive ISC license, you are free to do what you wish with this software. I hold
no liability for any defects and no guarantees are made to its usability.
Copyright James Eversole (james@eversole.co)