/Gopher-API

An API About Gophers!

Primary LanguageGo

GopherReview

Why

The purpose of this API is to power a website where people can keep a list of all the gophers in the world and track their age and favorite color.

Who

Why, you, of course! We need your help to add features to our API!

How

Please follow these instructions:

  1. You'll most likely be assigned an issue to work on
  2. Clone this repository to your workstation
  3. Create a branch for that issue like "feature-delete-gopher"
  4. Implement the code change neceessary to resolve the issue you've been assigned
  5. Push your changes back to this repository on your branch and open a pull request!
  6. Magic Happens

Pro Tips

If you've never written Go before, here are some tips:

  1. you'll want to install all the dependencies of this application by running go get -d ./...
  2. You can just run the program by running go run main.go
  3. Once it's running, use curl to interact with it like this: curl http://localhost:8080/ -D -

Resources

To get started with Go, we suggest the following resources

How to Write Go https://golang.org/doc/code.html

Writing Effective Go https://golang.org/doc/effective_go.html

A Tour of Go https://tour.golang.org/welcome/1

especially the section on slices https://tour.golang.org/moretypes/7 and appending to slices https://tour.golang.org/moretypes/15

The FAQ: https://golang.org/doc/faq

The Go standard library documentation: https://golang.org/pkg/ especially on JSON https://golang.org/pkg/encoding/json/

JSON and Go https://blog.golang.org/json-and-go

Ask for Help

If you're stuck or unsure about anything, please reach out with questions!