max/GoWeb
1
1
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 7 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Maximilian 2023-03-06 21:02:41 -06:00
parent 5a1cd77676
commit bd8b015f44
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,4 +1,4 @@
# GoWeb # GoWeb 🌐
GoWeb is a simple Go web framework that aims to only use the standard library. The overall file structure and 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 development flow is inspired by larger frameworks like Laravel. It is partially ready for smaller projects if you are
@ -7,7 +7,7 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
<hr> <hr>
## Current features ## Current features 🚀
- Routing/controllers - Routing/controllers
- Templating - Templating
@ -20,20 +20,20 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
<hr> <hr>
## When to use ## When to use 🙂
- You need to build a dynamic web application with persistent data - 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 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 - 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 - Pretty much any use-case where you would use Laravel, Django, or Flask
## When not to use ## When not to use 🙃
- You need a static website (see [Hugo](https://gohugo.io/)) - You need a static website (see [Hugo](https://gohugo.io/))
- You need a simple blog (see [Hugo](https://gohugo.io/)) - You need a simple blog (see [Hugo](https://gohugo.io/))
- You need a simple site for your projects' documentation (see [Hugo](https://gohugo.io/)) - You need a simple site for your projects' documentation (see [Hugo](https://gohugo.io/))
## How to use ## How to use 🤔
1. Clone 1. Clone
2. Run `go get` to install dependencies 2. Run `go get` to install dependencies
@ -41,7 +41,7 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
4. Run `go run main.go` to start the server 4. Run `go run main.go` to start the server
5. Start building your app! 5. Start building your app!
## How to contribute ## How to contribute 👨‍💻
- Open an issue on Github if you find a bug or have a feature request. - Open an issue on Github if you find a bug or have a feature request.
- [Email](mailto:contact@mpatterson.xyz) me a patch if you want to contribute code. - [Email](mailto:contact@mpatterson.xyz) me a patch if you want to contribute code.
@ -50,7 +50,7 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
<hr> <hr>
### License and disclaimer ### License and disclaimer 😤
- You are free to use this project under the terms of the MIT license. See LICENSE for more details. - 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. - You and you alone are responsible for the security and everything else regarding your application.