init

Author: pilcrowonpaper

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 pilcrowonpaper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,55 @@
+# github.com/faroedev/faroe
+
+_Documentation at [faroe.dev](https://faroe.dev)._
+
+_This software is in active development and has only gone through minimal testing._
+
+Faroe is a modular auth server distributed as a Go package.
+
+```
+go get github.com/faroedev/faroe
+```
+
+Some key features of the server:
+
+1. Takes care of all the hard parts. Passwords, email address verification, sessions, rate limiting, password resets, and more.
+2. Extends your existing user database instead of replacing it. Own and customize your user data. No more data synchronization between servers.
+3. No direct connections to your database. Just basic HTTP requests.
+4. Only ephemeral data is stored. Less things to manage and worry about.
+
+```ts
+const result = await client.createSignup(emailAddress);
+if (!result.ok) {
+    console.log(result.errorCode);
+    return;
+}
+console.log(result.signup);
+window.localStorage.setItem("signup_token", result.signupToken);
+```
+
+The package has no hard dependencies. All you need is a key-value store and an email server.
+
+```go
+package main
+
+import "github.com/faroedev/faroe"
+
+func main() {
+	server := faroe.NewServer(
+		mainStorage,
+		cache,
+		rateLimitStorage,
+		logger,
+		userPasswordHashAlgorithms,
+		temporaryPasswordHashAlgorithm,
+		cpuCount,
+		faroe.RealClock,
+		faroe.AllowAllEmailAddresses,
+		emailSender,
+		userActionInvocationEndpointClient,
+		sessionConfig,
+	)
+}
+```
+
+Only password authentication is supported. Support for passkeys and 2FA are planned but there are no immediate plans to add social login (e.g. Sign in with Google).