server

module

v0.0.0-...-2da20e2 Latest Latest Go to latest Published: Apr 16, 2026 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gopl-dev/server

Links

Open Source Insights

README ¶

🚀 Serving gopl.dev

Contributing

We don't have a formal set of rules for contributions yet; everyone is welcome! We appreciate everything from critiques and suggestions to bug fixes and new features.

Setup Your Own Instance

See SETUP.md for detailed instructions on how to set up your own instance.

Internal Tools

Reset Dev Environment
```
go run ./cmd/cli/main.go rde
```
Resets the development environment by recreating the database, applying migrations, and creating a default user. This is useful during active development if you need a clean state.
Database Seeding
```
go run ./cmd/cli/main.go sd
```
Seeds data into the database. By default, it seeds all available data. You can specify an entity and a count:
go run ./cmd/cli/main.go sd users 1000

Run go run ./cmd/cli/main.go ? sd to see all available options and detailed descriptions.

License MIT

Directories ¶

Path	Synopsis
app Package app ...	Package app ...
ds Package ds (Data Structure) All data models belonging to the app are stored here.	Package ds (Data Structure) All data models belonging to the app are stored here.
ds/prop Package prop provides property type definitions and utilities for handling different kinds of properties .	Package prop provides property type definitions and utilities for handling different kinds of properties .
repo Package repo ...	Package repo ...
service Package service ...	Package service ...
session Package session provides primitives for managing user sessions using JSON Web Tokens (JWT).	Package session provides primitives for managing user sessions using JSON Web Tokens (JWT).
cli Package cli provides a lightweight CLI framework with support for positional arguments, named parameters, and flags.	Package cli provides a lightweight CLI framework with support for positional arguments, named parameters, and flags.
cmd
cli command Package main is the entry point for the CLI application.	Package main is the entry point for the CLI application.
cli/commands Package commands ...	Package commands ...
new_db_migration command New DB migration.	New DB migration.
server command Package main is the entry point of the server application.	Package main is the entry point of the server application.
setup_wizard command Package main provides a CLI setup wizard for the gopl-server.	Package main provides a CLI setup wizard for the gopl-server.
diff Package diff provides word-level diff visualization with context-aware hunk merging.	Package diff provides word-level diff visualization with context-aware hunk merging.
email Package email ...	Package email ...
file Package file ...	Package file ...
frontend Package frontend handles the application's user-facing elements, such as serving static files and rendering HTML templates	Package frontend handles the application's user-facing elements, such as serving static files and rendering HTML templates
component templ: version: v0.3.960	templ: version: v0.3.960
component/icon templ: version: v0.3.960	templ: version: v0.3.960
layout templ: version: v0.3.960	templ: version: v0.3.960
page templ: version: v0.3.960	templ: version: v0.3.960
oauth
provider Package provider manages OAuth identity provider types and their validation.	Package provider manages OAuth identity provider types and their validation.
server Package server ...	Package server ...
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
endpoint Package endpoint ...	Package endpoint ...
handler Package handler contains HTTP handlers for the app's API endpoints.	Package handler contains HTTP handlers for the app's API endpoints.
middleware Package middleware ...	Package middleware ...
request Package request ...	Package request ...
response Package response provides structures and utilities for API responses.	Package response provides structures and utilities for API responses.
test Package test ...	Package test ...
factory
factory/random Package random provides utility functions for generating various types of random data.	Package random provides utility functions for generating various types of random data.
seed Package seed provides helpers for seeding test and development data.	Package seed provides helpers for seeding test and development data.
tracing Package tracing provides OpenTelemetry tracer initialization utilities.	Package tracing provides OpenTelemetry tracer initialization utilities.
worker Package worker provides a background job scheduler for running periodic maintenance tasks.	Package worker provides a background job scheduler for running periodic maintenance tasks.
cleanup_change_email_requests Package cleanupchangeemailrequests ...	Package cleanupchangeemailrequests ...
cleanup_deleted_books Package cleanupdeletedbooks provides a worker job for permanently removing soft-deleted books from the database after a retention period defined by ds.CleanupDeletedEntitiesAfterDays.	Package cleanupdeletedbooks provides a worker job for permanently removing soft-deleted books from the database after a retention period defined by ds.CleanupDeletedEntitiesAfterDays.
cleanup_deleted_users Package cleanupdeletedusers ...	Package cleanupdeletedusers ...
cleanup_expired_password_change_requests Package cleanupexpiredpasswordchangerequests ...	Package cleanupexpiredpasswordchangerequests ...
cleanup_expired_user_sessions Package cleanupexpiredusersessions ...	Package cleanupexpiredusersessions ...
cleanup_files Package cleanupfiles ...	Package cleanupfiles ...
delete_temp_files Package deletetempfiles ...	Package deletetempfiles ...
delete_unconfirmed_users Package deleteunconfirmedusers ...	Package deleteunconfirmedusers ...

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL