realworld-starter-kit icon indicating copy to clipboard operation
realworld-starter-kit copied to clipboard

Go examples API for a blog

RealWorld Example App

Go codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo    RealWorld

This codebase was created to demonstrate a fully fledged fullstack application built with Go including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Go community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

How it works

TODO

Describe the general architecture of your app here

Getting started

Installing and setting up Go

Getting the Project

go get github.com/JackyChiu/realworld-starter-kit
cd $GOPATH/src/github.com/JackyChiu/realworld-starter-kit

Building and Running

go build
./realworld-starter-kit

Testing

go test
# -v for verbose

Contributing

  • Comment one which issue you'd like to do
  • Fork the project then get the project: Getting the project
  • Now you have your own project URL (from your fork)
git remote rename origin upstream
git remote add origin {YOUR_URL}
  • After your first change make a PR with [WIP] (work in progress) added to the title.
  • When your ready for review assign one of us Gophers 🐹