This repository has been archived by the owner on Feb 24, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 578
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
108 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,108 @@ | ||
| module github.com/gobuffalo/buffalo | ||
|
|
||
| require ( | ||
| github.com/fatih/color v1.7.0 | ||
| github.com/gobuffalo/buffalo-plugins v0.0.0-20180812201729-80d79f93229e | ||
| github.com/gobuffalo/envy v1.6.3 | ||
| github.com/gobuffalo/makr v1.1.1 | ||
| github.com/gobuffalo/packr v1.13.1 | ||
| github.com/gobuffalo/plush v0.0.0-20180810170812-274552812256 | ||
| github.com/gobuffalo/pop v0.0.0-20180810203029-9f8bf0c11920 | ||
| github.com/markbates/deplist v1.0.2 | ||
| github.com/markbates/grift v1.0.1 | ||
| github.com/markbates/inflect v1.0.0 | ||
| github.com/markbates/refresh v1.4.1 | ||
| github.com/markbates/sigtx v1.0.0 | ||
| github.com/pkg/errors v0.8.0 | ||
| github.com/sirupsen/logrus v1.0.6 | ||
| github.com/spf13/cobra v0.0.3 | ||
| github.com/spf13/pflag v1.0.2 | ||
| github.com/spf13/viper v1.1.0 | ||
| golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f | ||
| ) | ||
| <p align="center"><img src="https://github.com/gobuffalo/buffalo/blob/master/logo.svg" width="360"></p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://godoc.org/github.com/gobuffalo/buffalo"><img src="https://godoc.org/github.com/gobuffalo/buffalo?status.svg" alt="GoDoc" /></a> | ||
| <a href="https://travis-ci.org/gobuffalo/buffalo"><img src="https://travis-ci.org/gobuffalo/buffalo.svg?branch=master" alt="Build Status" /></a> | ||
| <a href="https://ci.appveyor.com/project/markbates/buffalo/branch/master"><img src="https://ci.appveyor.com/api/projects/status/fjv5u499p78uvbxa/branch/master?svg=true&passingText=Windows%20-%20OK&failingText=Windows%20-%20failed&pendingText=Windows%20-%20pending" alt="Windows Build status" /></a> | ||
| <a href="https://codecov.io/gh/gobuffalo/buffalo"><img src="https://codecov.io/gh/gobuffalo/buffalo/branch/master/graph/badge.svg" alt="Code coverage status" /></a> | ||
| <a href="https://goreportcard.com/report/github.com/gobuffalo/buffalo"><img src="https://goreportcard.com/badge/github.com/gobuffalo/buffalo" alt="Go Report Card" /></a> | ||
| <a href="https://www.codetriage.com/gobuffalo/buffalo"><img src="https://www.codetriage.com/gobuffalo/buffalo/badges/users.svg" alt="Open Source Helpers" /></a> | ||
| </p> | ||
|
|
||
| # Buffalo | ||
|
|
||
| Buffalo is a Go web development eco-system. Designed to make the life of a Go web developer easier. | ||
|
|
||
| Buffalo starts by generating a web project for you that already has everything from front-end (JavaScript, SCSS, etc...) to back-end (database, routing, etc...) already hooked up and ready to run. From there it provides easy APIs to build your web application quickly in Go. | ||
|
|
||
| Buffalo isn't just a framework, it's a holistic web development environment and project structure that lets developers get straight to the business of, well, building their business. | ||
|
|
||
| > I :heart: web dev in go again - Brian Ketelsen | ||
| ## Documentation | ||
|
|
||
| Please visit [http://gobuffalo.io](http://gobuffalo.io) for the latest documentation, examples, and more. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| $ go get -u -v github.com/gobuffalo/buffalo/buffalo | ||
| ``` | ||
|
|
||
| _NOTE_: Buffalo has a minimum Go dependency of `1.8.1`. | ||
|
|
||
| Buffalo also depends on: | ||
| - gcc for [go-sqlite3](https://github.com/mattn/go-sqlite3) which is a cgo package. | ||
| - node and npm for the asset pipeline. | ||
|
|
||
| ## Generating a new Project | ||
|
|
||
| Buffalo aims to make building new web applications in Go as simple as possible, and what could be more simple than a new application generator? | ||
|
|
||
| ```text | ||
| $ buffalo new <name> | ||
| ``` | ||
|
|
||
| That will generate a whole new Buffalo application that is ready to go. It'll even run `go get` for you to make sure you have all of the necessary dependencies needed to run your application. | ||
|
|
||
| To see a list of available flags for the `new` command, just check out its help. | ||
|
|
||
| ```text | ||
| $ buffalo help new | ||
| ``` | ||
|
|
||
| ## Running your application | ||
|
|
||
| Buffalo is Go "standards" compliant. That means you can just build your binary and run it. It's that simple. | ||
|
|
||
| ### Running your application in Development | ||
|
|
||
| One of the downsides to Go development is the lack of code "reloading". This means as you change your code you need to manually stop your application, rebuild it, and then restart it. Buffalo finds this is annoying and wants to make life better for you. | ||
|
|
||
| ```text | ||
| $ buffalo dev | ||
| ``` | ||
|
|
||
| The `dev` command will watch your `.go` and `.html` files by default, rebuild, and restart your binary for you so you don't have to worry about such things. Just run the `dev` command and start coding. | ||
|
|
||
| ## Testing your application | ||
|
|
||
| Just like running your application, Buffalo doesn't stop you from using the standard Go tools for testing. Buffalo does ship with a `test` command that will run all of your tests while conveniently skipping that pesky old `./vendor` directory! | ||
|
|
||
| ```text | ||
| $ buffalo test | ||
| ``` | ||
|
|
||
| ## Shoulders of Giants | ||
|
|
||
| Buffalo would not be possible if not for all of the great projects it depends on. Please see [SHOULDERS.md](SHOULDERS.md) to see a list of them. | ||
|
|
||
| ### Templating | ||
|
|
||
| [github.com/gobuffalo/plush](https://github.com/gobuffalo/plush) - This templating package was chosen over the standard Go `html/template` package for a variety of reasons. The biggest of which is that it is significantly more flexible and easy to work with. | ||
|
|
||
| ### Routing | ||
|
|
||
| [github.com/gorilla/mux](https://github.com/gorilla/mux) - This router was chosen because of its stability and flexibility. There might be faster routers out there, but this one is definitely the most powerful! | ||
|
|
||
| ### Task Runner (Optional) | ||
|
|
||
| [github.com/markbates/grift](https://github.com/markbates/grift) - If you're familiar with Rake tasks from Ruby, you'll be right at home using Grift. This package was chosen to allow for the easy running of simple, and common, tasks that most web applications need. Think things like seeding a database or taking in a CSV file and generating database records. Buffalo ships with an example `routes` task that prints off the defined routes and the function that handles those requests. | ||
|
|
||
| ### Models/ORM (Optional) | ||
|
|
||
| [github.com/gobuffalo/pop](https://github.com/gobuffalo/pop) - Accessing databases is nothing new in web applications. Pop, and its command line tool, Soda, were chosen because they strike a nice balance between simplifying common tasks, being idiomatic, and giving you the flexibility you need to built your app. Pop and Soda share the same core philosphies as Buffalo so they were a natural choice. | ||
|
|
||
| ### Sessions, Cookies, Websockets, and more... | ||
|
|
||
| [github.com/gorilla](https://github.com/gorilla) - The Gorilla toolkit is a great set of packages designed to improve upon the standard library for a variety of web-related packages. With these high quality packages Buffalo is able to keep its "core" code to a minimum and focus on its goal of glueing them all together to make your life better. | ||
|
|
||
| ## Benchmarks | ||
|
|
||
| Oh, yeah, everyone wants benchmarks! What would a web framework be without its benchmarks? Well, guess what? I'm not giving you any! That's right. This is Go! I assure you that it is plenty fast enough for you. If you want benchmarks you can either a) checkout any benchmarks that the [GIANTS](SHOULDERS.md) Buffalo is built upon have published, or b) run your own. I have no interest in playing the benchmark game, and neither should you. | ||
|
|
||
| ## Contributing | ||
|
|
||
| First, thank you so much for wanting to contribute! It means so much that you care enough to want to contribute. We appreciate every PR from the smallest of typos to the be biggest of features. | ||
|
|
||
| To contribute, please read the contribution guidelines: [CONTRIBUTING](CONTRIBUTING.md) |