2022-12-21 11:46:05 -06:00
|
|
|
purr
|
|
|
|
-----
|
|
|
|
|
2022-12-21 12:06:46 -06:00
|
|
|
https://purr.eversole.co
|
2023-05-07 14:04:25 -05:00
|
|
|
a work-in-progress web application offering customizable password generation
|
|
|
|
and time-limited sharing of secrets.
|
2022-12-21 11:46:05 -06:00
|
|
|
|
2022-12-27 12:25:14 -06:00
|
|
|
TECH STACK
|
|
|
|
|
|
|
|
- Haskell and Scotty backend
|
|
|
|
- HTMX frontend
|
|
|
|
- SQLite database
|
|
|
|
|
2022-12-21 11:46:05 -06:00
|
|
|
GOALS
|
|
|
|
|
2023-05-07 14:04:25 -05:00
|
|
|
- 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.
|
|
|
|
|
2022-12-21 11:46:05 -06:00
|
|
|
- Provide a minimal and clean interface for generating and sharing passwords.
|
2023-05-07 14:04:25 -05:00
|
|
|
|
|
|
|
- Maintain a clean and organized codebase that can be extended to include more
|
|
|
|
utilities than originally anticipated.
|
2022-12-21 11:46:05 -06:00
|
|
|
|
2024-02-17 08:23:10 -06:00
|
|
|
- Be really cute compared to the competition.
|
|
|
|
|
2022-12-21 11:46:05 -06:00
|
|
|
WHY TRUST YOU?
|
|
|
|
|
2023-05-07 14:04:25 -05:00
|
|
|
You shouldn't. This is free and open-source software which you can run on your
|
|
|
|
own hardware.
|
2022-12-21 11:46:05 -06:00
|
|
|
|
2022-12-27 12:25:14 -06:00
|
|
|
DEPLOYMENT
|
2022-12-21 11:46:05 -06:00
|
|
|
|
2024-02-17 08:34:26 -06:00
|
|
|
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
|
2022-12-21 11:46:05 -06:00
|
|
|
|
|
|
|
DEVELOPMENT & SUPPORT
|
|
|
|
|
2023-06-16 16:32:26 -05:00
|
|
|
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.
|
2022-12-21 11:46:05 -06:00
|
|
|
|
2023-06-16 16:32:26 -05:00
|
|
|
Copyright James Eversole (james@eversole.co)
|