max/GoWeb
1
1
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 7 Wiki Activity
A Go web framework with user authentication, CSRF protection, templating, config handling, and simple migrations out of the box
116 Commits 5 Branches 7 Tags 342 KiB
Go 91%
HTML 5.2%
CSS 3.8%
ac19e2515a
Go to file
Maximilian ac19e2515a Go mod tidy and update x/crypto
2023-09-17 19:25:38 -05:00
app Better naming of functions and files, delete less than helpful comments 2023-08-03 12:09:40 -05:00
config Use TOML for config 2023-09-04 15:21:26 -05:00
controllers Clean up error handling, migrate to log/slog, add todo for flash message system in post controller 2023-09-03 15:45:12 -05:00
database Make all slog errors uniform (lowercase) 2023-09-03 15:56:35 -05:00
middleware Clean up error handling, migrate to log/slog, add todo for flash message system in post controller 2023-09-03 15:45:12 -05:00
models Clean up error handling, migrate to log/slog, add todo for flash message system in post controller 2023-09-03 15:45:12 -05:00
restclient Handle errors 2023-08-03 12:13:15 -05:00
routes Make all slog errors uniform (lowercase) 2023-09-03 15:56:35 -05:00
security Make all slog errors uniform (lowercase) 2023-09-03 15:56:35 -05:00
static/css Add default theme and apply to pages 2023-03-06 12:44:20 -06:00
templates Properly set the name of the checkbox for parsing 2023-04-06 09:31:12 -05:00
templating Clean up error handling, migrate to log/slog, add todo for flash message system in post controller 2023-09-03 15:45:12 -05:00
.gitattributes Add .gitattributes to force LF line endings 2023-05-05 12:19:17 -05:00
.gitignore Add more to .gitignore 2023-03-06 21:23:56 -06:00
env_example.toml Use TOML for config 2023-09-04 15:20:21 -05:00
go.mod Go mod tidy and update x/crypto 2023-09-17 19:25:38 -05:00
go.sum Go mod tidy and update x/crypto 2023-09-17 19:25:38 -05:00
LICENSE Add license 2023-01-07 22:08:25 -06:00
main.go Make all slog errors uniform (lowercase) 2023-09-03 15:56:35 -05:00
README.md Use TOML for config 2023-09-04 15:20:21 -05:00

README.md

GoWeb 🌐

GoWeb is a simple Go web framework that aims to only use the standard library. The overall file structure and development flow is inspired by larger frameworks like Laravel. It is partially ready for smaller projects if you are fine with getting your hands dirty, but I plan on having it ready to go for more serious projects when it hits version 2.0.

Current features 🚀

  • Routing/controllers
  • Templating
  • Simple database migration system
  • Built in REST client
  • CSRF protection
  • Middleware
  • Minimal user login/registration + sessions
  • Config file handling
  • Scheduled tasks
  • Entire website compiles into a single binary (~10mb) (excluding env.toml)
  • Minimal dependencies (just standard library, postgres driver, and experimental package for bcrypt)

When to use 🙂

  • You need to build a dynamic web application with persistent data
  • You need to build a dynamic website using Go and need a good starting point
  • You need to build an API in Go and don't know where to start
  • Pretty much any use-case where you would use Laravel, Django, or Flask

When not to use 🙃

  • You need a static website (see Hugo)
  • You need a simple blog (see Hugo)
  • You need a simple site for your projects' documentation (see Hugo)

How to use 🤔

  1. Clone
  2. Delete the git folder, so you can start tracking in your own repo
  3. Run go get to install dependencies
  4. Copy env_example.toml to env.toml and fill in the values
  5. Run go run main.go to start the server
  6. Rename the occurences of "GoWeb" to your app name
  7. Start building your app!
  8. When you see useful changes to GoWeb you'd like in your project copy them over

How to contribute 👨‍💻

  • Open an issue on GitHub if you find a bug or have a feature request.
  • Email me a patch if you want to contribute code.
    • Please include a good description of what the patch does and why it is needed, also include how you want to be credited in the commit message.

License and disclaimer 😤

  • You are free to use this project under the terms of the MIT license. See LICENSE for more details.
  • You and you alone are responsible for the security and everything else regarding your application.
  • It is not required, but I ask that when you use this project you give me credit by linking to this repository.
  • I also ask that when releasing self-hosted or other end-user applications that you release it under the GPLv3 license. This too is not required, but I would appreciate it.