commit b4d6e9c9d1935e5081f7e0f2b5f7d9a98f6857a7 Author: James Eversole Date: Tue Jun 28 20:30:09 2022 -0500 Initialize stack environment and repository diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..22a6389 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.stack-work/ +./data +./config.dhall +*~ diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 index 0000000..5ccc7db --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,3 @@ +# Changelog for Purr + +## Unreleased changes diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9b8eac7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,5 @@ +Copyright 2022 James Eversole + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/Purr.cabal b/Purr.cabal new file mode 100644 index 0000000..4392a25 --- /dev/null +++ b/Purr.cabal @@ -0,0 +1,54 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.34.4. +-- +-- see: https://github.com/sol/hpack + +name: Purr +version: 0.1.0.0 +description: https://git.eversole.co/James/Purr +author: James Eversole +maintainer: james@eversole.co +copyright: 2022 James Eversole +license: ISC +license-file: LICENSE +build-type: Simple +extra-source-files: + README.md + ChangeLog.md + +library + exposed-modules: + Lib + other-modules: + Paths_Purr + hs-source-dirs: + src + build-depends: + base >=4.7 && <5 + default-language: Haskell2010 + +executable Purr-exe + main-is: Main.hs + other-modules: + Paths_Purr + hs-source-dirs: + app + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + Purr + , base >=4.7 && <5 + default-language: Haskell2010 + +test-suite Purr-test + type: exitcode-stdio-1.0 + main-is: Spec.hs + other-modules: + Paths_Purr + hs-source-dirs: + test + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + Purr + , base >=4.7 && <5 + default-language: Haskell2010 diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d259ab --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Purr - Password Generation and Sharing +![Big Purr and Sploot](https://eversole.co/Purr-Small.png "Purr!") +Purr is a work-in-progress web application offering customizable password generation and time-limited link sharing features. + +## What problems does Purr solve? +1. Generating sufficiently memorable but secure passwords for use with accounts that don't offer better authentication methods. +2. Sharing passwords or other text secrets with others via email/chat/etc., without disclosing the password itself. As passwords expire after a predefined period, the email/chat history where the information was shared don't become a purr-manent (sorry, **permanent**) vulnerability. +3. Being really cute compared to the competition. + +## Tech Stack? +1. [Haskell](https://www.haskell.org) and [Scotty](https://github.com/scotty-web/scotty) backend. +2. [HTMX](https://github.com/bigskysoftware/htmx) and [Alpine.js](https://github.com/alpinejs/alpine) for the frontend. +3. [MongoDB](https://github.com/mongodb/mongo) database. + +## Why should I trust you with my passwords? +You shouldn't! This is free and open-source software which you can run on your own hardware. Instructions for deployment are coming soon. + +## 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) diff --git a/Setup.hs b/Setup.hs new file mode 100644 index 0000000..9a994af --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 index 0000000..de1c1ab --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,6 @@ +module Main where + +import Lib + +main :: IO () +main = someFunc diff --git a/package.yaml b/package.yaml new file mode 100644 index 0000000..b671b7a --- /dev/null +++ b/package.yaml @@ -0,0 +1,47 @@ +name: Purr +version: 0.1.0.0 +license: ISC +author: "James Eversole" +maintainer: "james@eversole.co" +copyright: "2022 James Eversole" + +extra-source-files: +- README.md +- ChangeLog.md + +# Metadata used when publishing your package +# synopsis: Short description of your package +# category: Web + +# To avoid duplicated efforts in documentation and dealing with the +# complications of embedding Haddock markup inside cabal files, it is +# common to point users to the README.md file. +description: https://git.eversole.co/James/Purr + +dependencies: +- base >= 4.7 && < 5 + +library: + source-dirs: src + +executables: + Purr-exe: + main: Main.hs + source-dirs: app + ghc-options: + - -threaded + - -rtsopts + - -with-rtsopts=-N + dependencies: + - Purr + +tests: + Purr-test: + main: Spec.hs + source-dirs: test + ghc-options: + - -threaded + - -rtsopts + - -with-rtsopts=-N + dependencies: + - Purr diff --git a/src/Lib.hs b/src/Lib.hs new file mode 100644 index 0000000..d36ff27 --- /dev/null +++ b/src/Lib.hs @@ -0,0 +1,6 @@ +module Lib + ( someFunc + ) where + +someFunc :: IO () +someFunc = putStrLn "someFunc" diff --git a/stack.yaml b/stack.yaml new file mode 100644 index 0000000..6a97795 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,67 @@ +# This file was automatically generated by 'stack init' +# +# Some commonly used options have been documented as comments in this file. +# For advanced use and comprehensive documentation of the format, please see: +# https://docs.haskellstack.org/en/stable/yaml_configuration/ + +# Resolver to choose a 'specific' stackage snapshot or a compiler version. +# A snapshot resolver dictates the compiler version and the set of packages +# to be used for project dependencies. For example: +# +# resolver: lts-3.5 +# resolver: nightly-2015-09-21 +# resolver: ghc-7.10.2 +# +# The location of a snapshot can be provided as a file or url. Stack assumes +# a snapshot provided as a file might change, whereas a url resource does not. +# +# resolver: ./custom-snapshot.yaml +# resolver: https://example.com/snapshots/2018-01-01.yaml +resolver: + url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/19/13.yaml + +# User packages to be built. +# Various formats can be used as shown in the example below. +# +# packages: +# - some-directory +# - https://example.com/foo/bar/baz-0.0.2.tar.gz +# subdirs: +# - auto-update +# - wai +packages: +- . +# Dependency packages to be pulled from upstream that are not in the resolver. +# These entries can reference officially published versions as well as +# forks / in-progress versions pinned to a git hash. For example: +# +# extra-deps: +# - acme-missiles-0.3 +# - git: https://github.com/commercialhaskell/stack.git +# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a +# +# extra-deps: [] + +# Override default flag values for local packages and extra-deps +# flags: {} + +# Extra package databases containing global packages +# extra-package-dbs: [] + +# Control whether we use the GHC we find on the path +# system-ghc: true +# +# Require a specific version of stack, using version ranges +# require-stack-version: -any # Default +# require-stack-version: ">=2.7" +# +# Override the architecture used by stack, especially useful on Windows +# arch: i386 +# arch: x86_64 +# +# Extra directories used by stack for building +# extra-include-dirs: [/path/to/dir] +# extra-lib-dirs: [/path/to/dir] +# +# Allow a newer minor version of GHC than the snapshot specifies +# compiler-check: newer-minor diff --git a/stack.yaml.lock b/stack.yaml.lock new file mode 100644 index 0000000..b608c4e --- /dev/null +++ b/stack.yaml.lock @@ -0,0 +1,13 @@ +# This file was autogenerated by Stack. +# You should not edit this file by hand. +# For more information, please see the documentation at: +# https://docs.haskellstack.org/en/stable/lock_files + +packages: [] +snapshots: +- completed: + size: 618740 + url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/19/13.yaml + sha256: ef98d70e4018bf01feb00ccdcd33ab26d056dbb71b38057c78fdd0d1ec671c85 + original: + url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/19/13.yaml diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 index 0000000..cd4753f --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,2 @@ +main :: IO () +main = putStrLn "Test suite not yet implemented"