https://github.com/daedalus-developers/auth-sveltekit
An Authentication starter for SvelteKit
https://github.com/daedalus-developers/auth-sveltekit
Last synced: over 1 year ago
JSON representation
An Authentication starter for SvelteKit
- Host: GitHub
- URL: https://github.com/daedalus-developers/auth-sveltekit
- Owner: daedalus-developers
- Created: 2024-03-24T13:02:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T10:15:17.000Z (about 2 years ago)
- Last Synced: 2025-04-16T01:54:50.325Z (over 1 year ago)
- Language: Svelte
- Homepage: https://auth-sveltekit.mkra.dev/
- Size: 406 KB
- Stars: 31
- Watchers: 4
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Auth Kit
## Svelte 5
Will migrate everything to svelte 5 once it's out, my personal fork will be used to track it's progress.
- [ ] Update to Svelte 5
- [ ] Shadcn-svelte(bits-ui) waiting for next branches
- [ ] Lucia, [Arctic](https://arcticjs.dev) and [OsloJS](https://oslojs.dev) migrations to new version
- [ ] Remove the products page
An Authentication Base Application built with SvelteKit.
Libraries Used:
- [x] [Drizzle ORM](https://orm.drizzle.team)
- [x] [Lucia v3](https://lucia-auth.com)
- [x] [Sveltekit-Superforms](https://superform.rocks)
- [x] [Shadcn-svelte](https://shadcn-svelte.com)
## Goals
Registration
- [x] Email is only required after that a confirmation will be sent to the email address
Login
- [x] User can login with username/email and password
- [x] User can login via OTP
- [x] The email sent should also have a link and a state in the url
Rate limiting
- [x] Sending OTP, IP+UA limitation should only be 5 per 15minutes
- [x] Wrong OTP Verification should only be 5 per 15minutes
Onboarding
- [x] Welcome, Update Account, Select Tier Subscription, Select Payment Method, Finished Section
Documentation
- [ ] Guide into changing database to postgres and mariadb
- [ ] Diagrams for how the authentication flow works
Admin dashboard
- [ ] To manage backups etc...
Demo dashboard apps
- [ ] AI Prompt
- [ ] Customer Maanager + Invoices (localfirst ?)
- [ ] Chat Application
- [ ] File Manager(emulate a google drive like)
## Development
In order to start the development server, run the following command:
Environment Setup
```sh
cp .env.example .env # Creates a copy of .env.example to .env
```
```sh
#.env
DATABASE_URL=postgres://username:password@host:port/dbname # For local development only
SMTP_HOST=smtp.example.com # your smtp host
SMTP_PORT=587 # your smtp port
SMTP_USER=your_email@example.com
SMTP_PASSWORD=password
SMTP_FROM_NAME="Auth Kit" # if with spaces
SMTP_FROM_EMAIL=noreply@example.com # only used for verifications,
SMTP_REPLY_TO=noreply@example.com #
ORIGIN="https://example.com" # your domain name
GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET=""
GITHUB_CALLBACK_URL=http://localhost:5173/oauth/github/callback
GOOGLE_CLIENTID=""
GOOGLE_CLIENTSECRET=""
GOOGLE_CALLBACK_URL=http://localhost:5173/oauth/google/callback
STORAGE_ACCESS_KEY=accesskey
STORAGE_SECRET_KEY=secretkey
STORAGE_URL= #customdomain or .r2 or s3 url
# do not include /bucketname for r2,
STORAGE_ENDPOINT=https://yoururl.r2.cloudflarestorage.com
STORAGE_BUCKET=bucketname
```
Create a bucket and get your credentials from the storage provider
This requires a storage provider like minio, r2, or any s3 compatible provider.
READ more about it [here](https://developers.cloudflare.com/r2/get-started/)
Create your Database for now the schemas are written in postgres, create a neon or vercel postgres database, or run your own in a container for development
e.g
```sh
pnpm db:migrate # or npm run db:migrate
# Optional if you just want to login and check whats inside
pnpm db:seed # or npm run db:seed
```
Run the development server
```sh
pnpm dev # or npm run dev
```
# Deploying
WIP but a dockerfile is included.