https://github.com/thedevsaddam/orchid
A MVC style boilerplate for golang
https://github.com/thedevsaddam/orchid
golang-boilerplate golang-examples golang-wrapper
Last synced: 8 months ago
JSON representation
A MVC style boilerplate for golang
- Host: GitHub
- URL: https://github.com/thedevsaddam/orchid
- Owner: thedevsaddam
- License: mit
- Created: 2017-04-02T05:33:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-14T12:29:44.000Z (over 7 years ago)
- Last Synced: 2025-04-09T23:04:13.410Z (8 months ago)
- Topics: golang-boilerplate, golang-examples, golang-wrapper
- Language: Go
- Homepage:
- Size: 116 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Orchid
=================
Golang MVC style boilerplate using gin-gonic framework with gorm ORM.
### Installation
* Go to your `$GOPATH/src` and clone the directory using `git clone https://github.com/thedevsaddam/orchid.git`
or [download the zip file](https://github.com/thedevsaddam/orchid/archive/master.zip)
* Install dependency manager `govendor` using the command below
```
go get -u github.com/kardianos/govendor
```
* Go to the `$GOPATH/src/orchid/vendor` directory and install dependencies using `govendor sync` command
* Copy `.env.example` to `.env` and set your configurations.
* Run `go build` to build binary file and to start the application use `./orchid`
### Todo
- [x] Routing
- [x] Model
- [x] Views
- [x] Controller
- [x] Session
- [x] Middleware
- [ ] CSRF protection
- [ ] Job Queue
- [ ] Caching
- [ ] Localization
- [ ] Helpers
- [ ] OAuth2 server
- [ ] Fixing inconsistent codes
- [ ] Request validation
- [ ] Add some helper function
- [ ] Security
- [ ] Find out performance issues
- [ ] Benchmarking
### Credits
* Routing, session and templating [gin-gonic](https://gin-gonic.github.io/gin)
* Object-relational mapping [gorm](https://github.com/jinzhu/gorm)
* Dependency management package [govendor](https://github.com/kardianos/govendor)
* Environment management package [godotenv](https://github.com/joho/godotenv)
### Contribution
As it is the very begining of *Orchid* boilerplate, we need a good amount for contribution from you.
If you are interested to contribute please feel free to send pull request.
##### Note:
I am doing R&D with the project. Don't use it untill it is tagged.
### License
The **Orchid** is a open-source software licensed under the [MIT License](LICENSE.md).