wharf-provider-github

GitHub provider for Wharf

Import Wharf projects from GitHub repositories. Mainly focused on importing from github.com, importing from GitHub EE is not well tested.

Components

• HTTP API using the gin-gonic/gin web framework.

• Swagger documentation generated using swaggo/swag and hosted using swaggo/gin-swagger

• GitHub API client using google/go-github

Development

1. Install Go 1.13 or later: https://golang.org/

2. Install the swaggo/swag CLI globally:

   # Run this outside of any Go module, including this repository, to not
   # have `go get` update the go.mod file.
   $ cd ..
   
   $ go get -u github.com/swaggo/swag
   

3. Generate the swaggo files (this has to be redone each time the swaggo documentation comments has been altered):

   # Navigate back to this repository
   $ cd wharf-provider-github
   
   # Generate the files into docs/
   $ swag
   

4. Start hacking with your favorite tool. For example VS Code, GoLand, Vim, Emacs, or whatnot.

Maintained by Iver. Licensed under the MIT license.