James/purr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
purr/README.md

27 lines
1.8 KiB
Markdown
Raw Normal View History

Updated README with project goals, started prototyping frontend and added route for primary css dist, added reasonable functionality for requesting a password directly via link as well as patching index DOM when requesting HTML stub from /pw
2022-07-03 21:48:40 -05:00
# Purr - Password Generation and Secret Sharing
Initialize stack environment and repository
2022-06-28 20:30:09 -05:00
![Big Purr and Sploot](https://eversole.co/Purr-Small.png "Purr!")
Updated README with project goals, started prototyping frontend and added route for primary css dist, added reasonable functionality for requesting a password directly via link as well as patching index DOM when requesting HTML stub from /pw
2022-07-03 21:48:40 -05:00
Purr is a work-in-progress web application offering customizable password generation and time-limited sharing of secrets.
Initialize stack environment and repository
2022-06-28 20:30:09 -05:00
## What problems does Purr solve?
1. Generating sufficiently memorable but secure passwords for use with accounts that don't offer better authentication methods.
Updated README with project goals, started prototyping frontend and added route for primary css dist, added reasonable functionality for requesting a password directly via link as well as patching index DOM when requesting HTML stub from /pw
2022-07-03 21:48:40 -05:00
2. Sharing text secrets with others without disclosing the secret in the message itself. As secrets expire after a predefined period, the email/chat history where the information was shared don't become a purr-manent (sorry, **permanent**) vulnerability.
Initialize stack environment and repository
2022-06-28 20:30:09 -05:00
3. Being really cute compared to the competition.
Updated README with project goals, started prototyping frontend and added route for primary css dist, added reasonable functionality for requesting a password directly via link as well as patching index DOM when requesting HTML stub from /pw
2022-07-03 21:48:40 -05:00
## Why should I trust you with my secrets?
Squashed commit of the following: commit 86ee3c4d262916bec531ad5616273b391cdffeb3 Author: James Eversole <james@eversole.co> Date: Tue Jul 5 20:09:22 2022 -0500 Refactored findByLink for modularity, started prototyping document creation commit 65b68df295069edb57adcdc16a3300c9d762dc2f Author: James Eversole <james@eversole.co> Date: Tue Jul 5 18:45:25 2022 -0500 Feature parity with MongoDB implementation in main; need to refactor Feature.Sharing.Couch.findByLink into multiple functions so that more information regarding retrieved documents can be used compositionally to DRY before merging into main commit e10cc4de8acd45488679f0587732f02fee950c77 Author: James Eversole <james@eversole.co> Date: Mon Jul 4 20:53:55 2022 -0500 Better configuration file keys commit d683a51cac4ad891856f7782aa6221402988fea4 Author: James Eversole <james@eversole.co> Date: Mon Jul 4 20:38:40 2022 -0500 Added beginnings of CouchDB logic while removing all Mongo references and dependencies. Updated configuration file and related data types. Added a MonadHttp instance for PurrAction to enable requests in their monadic context. Will merge into main once feature parity on the Sharing Feature is reached
2022-07-05 20:11:41 -05:00
You shouldn't! This is [free and open-source software](https://git.eversole.co/James/Purr/src/branch/main/LICENSE) which you can run on your own hardware. Instructions for deployment are coming!
Updated README with project goals, started prototyping frontend and added route for primary css dist, added reasonable functionality for requesting a password directly via link as well as patching index DOM when requesting HTML stub from /pw
2022-07-03 21:48:40 -05:00
Initialize stack environment and repository
2022-06-28 20:30:09 -05:00
## Tech Stack?
1. [Haskell](https://www.haskell.org) and [Scotty](https://github.com/scotty-web/scotty) backend.
Updated README with project goals, started prototyping frontend and added route for primary css dist, added reasonable functionality for requesting a password directly via link as well as patching index DOM when requesting HTML stub from /pw
2022-07-03 21:48:40 -05:00
2. [HTMX](https://github.com/bigskysoftware/htmx) for the frontend.
Squashed commit of the following: commit 9aaa5307e7671bc8bcc444733a6e38999f346772 Author: James Eversole <james@eversole.co> Date: Mon Jul 18 16:03:43 2022 -0500 Completed migration to SQLite, full feature parity with original Mongo/Couch implementations. Added ability to submit new passwords with full frontend functionality. Generation of random links now functions as expected and Unix Epoch Timestamps are now included in DB entries.
2022-07-18 16:04:10 -05:00
3. [SQLite](https://github.com/sqlite/sqlite) database.
Initialize stack environment and repository
2022-06-28 20:30:09 -05:00
Updated README with project goals, started prototyping frontend and added route for primary css dist, added reasonable functionality for requesting a password directly via link as well as patching index DOM when requesting HTML stub from /pw
2022-07-03 21:48:40 -05:00
## Project Goals
1. Provide a minimal and clean interface for generating and sharing passwords.
2. Maintain a clean and organized codebase that can be extended to include more utilities than originally anticipated.
Initialize stack environment and repository
2022-06-28 20:30:09 -05:00
## Development & Support
Please send me an [email](mailto:james@eversole.co) or join the [Support Chat](openpgp4fpr://FEB27223219E8DB3203225350462EA0901FE08F7#a=james%40eversole.co&g=Purr%20Support&x=RbVs8iQCVnf&i=-FuzUDK_RM1&s=KgeGtFFJtkq) in [DeltaChat](https://delta.chat)!
![Join Purr DeltaChat Group - QR Code](https://eversole.co/PurrSupport.png "Purr Support QR Code!")
Copyright (C) 2022-2022 [James Eversole](https://eversole.co)
Reference in New Issue Copy Permalink