archive/superkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs and mod

Browse source
This commit is contained in:
anthdm 2024-06-16 11:50:54 +02:00
parent f28da98d27
commit d8237590c1
4 changed files with 19 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -30,7 +30,7 @@ Create interactive applications with Golang, HTMX, and Templ
- [Create a production release](#create-a-production-release)
# Installation
Install SUPERKIT in a single command:
Create your SUPERKIT project in a single command:
```
go run github.com/anthdm/gothkit@master [yourprojectname]
```
@ -40,11 +40,21 @@ You can now navigate to your project:
cd [myprojectname]
```
Run npm install
Run npm install to install both tailwindcss and esbuild locally.
```
npm install
```
If you run into dependency issues you can run:
```
go clean -modcache && go get -u ./...
```
If you have the authentication plugin enabled you need to migrate your database.
```
make db-up
```
# Getting started
## Application structure
### assets

1
bootstrap/.env.local
View file

@ -25,4 +25,5 @@ SUPERKIT_SECRET = {{app_secret}}
# Authentication Plugin
SUPERKIT_AUTH_REDIRECT_AFTER_LOGIN = /profile
SUPERKIT_AUTH_SESSION_EXPIRY_IN_HOURS = 48
# Skip user email verification
SUPERKIT_AUTH_SKIP_VERIFY = true

2
bootstrap/go.mod
View file

@ -4,7 +4,7 @@ go 1.22.4
require (
github.com/a-h/templ v0.2.707
github.com/anthdm/gothkit v0.0.0-20240615140127-d74e729d7c71
github.com/anthdm/gothkit v0.0.0-20240616091834-f28da98d2790
github.com/go-chi/chi/v5 v5.0.12
github.com/google/uuid v1.6.0
github.com/joho/godotenv v1.5.1

2
bootstrap/go.sum
View file

@ -2,6 +2,8 @@ github.com/a-h/templ v0.2.707 h1:T1Gkd2ugbRglZ9rYw/VBchWOSZVKmetDbBkm4YubM7U=
github.com/a-h/templ v0.2.707/go.mod h1:5cqsugkq9IerRNucNsI4DEamdHPsoGMQy99DzydLhM8=
github.com/anthdm/gothkit v0.0.0-20240615140127-d74e729d7c71 h1:lTQ0cqCoXVCJRdAPjJTUhqHcAdF4EcAxARSgCO4Ny9o=
github.com/anthdm/gothkit v0.0.0-20240615140127-d74e729d7c71/go.mod h1:SFEB0yWZV7/rEtE+I3u3rJ7HXRWYAami+3gyAH+2d8c=
github.com/anthdm/gothkit v0.0.0-20240616091834-f28da98d2790 h1:Tt7InsQNmnrYwZW9SFNnSoBhdJgYvqF50wLb2kbeIVM=
github.com/anthdm/gothkit v0.0.0-20240616091834-f28da98d2790/go.mod h1:SFEB0yWZV7/rEtE+I3u3rJ7HXRWYAami+3gyAH+2d8c=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM=