https://github.com/apprentice3d/forge-go-template

Simple boilerplate for Forge projects on Go
https://github.com/apprentice3d/forge-go-template

Last synced: 10 months ago
JSON representation

Simple boilerplate for Forge projects on Go

• Host: GitHub
• URL: https://github.com/apprentice3d/forge-go-template
• Owner: apprentice3d
• License: mit
• Created: 2018-02-01T06:03:29.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-28T13:42:37.000Z (over 5 years ago)
• Last Synced: 2024-06-20T17:55:39.010Z (over 1 year ago)
• Language: Go
• Size: 2.52 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# forge-go-template

[![Build Status](https://travis-ci.org/apprentice3d/forge-go-template.svg?branch=master)](https://travis-ci.org/apprentice3d/forge-go-template)

[![Go Report Card](https://goreportcard.com/badge/github.com/apprentice3d/forge-go-template)](https://goreportcard.com/report/github.com/apprentice3d/forge-go-template)

![Platforms](https://img.shields.io/badge/platform-windows%20%7C%20osx%20%7C%20linux-lightgray.svg)

**Forge API:** [![oAuth2](https://img.shields.io/badge/oAuth2-v1-green.svg)](http://developer-autodesk.github.io/)

[![Viewer](https://img.shields.io/badge/Viewer-v3.3-green.svg)](http://developer.autodesk.com/)

[![OSS](https://img.shields.io/badge/OSS-v2-green.svg)](http://developer.autodesk.com/)

[![Model-Derivative](https://img.shields.io/badge/Model%20Derivative-v2-green.svg)](http://developer.autodesk.com/)

`forge-go-template` is a simple working boilerplate for Forge projects served by Go.

## Setup

Set the ```FORGE_CLIENT_ID``` and ```FORGE_CLIENT_SECRET``` environment

variables with your Forge secrets.

Grab the zip archive from the [releases](https://github.com/apprentice3d/forge-go-template/releases) page

and un-archive it into a favorite folder.

If you have Go already setup, and you want to build it by yourself, run:

    go get -u github.com/apprentice3d/forge-go-template

change to created/updated directory:

    cd $GOPATH/src/github.com/apprentice3d/forge-go-template

and start it by running

    go run main.go

or build it by running

    go build

## Usage

This app will find an available port and startusing it.

To start the app just run the `forge-go-template` executable.

If everything setup, you should see a terminal window like this:

![](./doc/terminal.png)

meaning the web app can be accessed at `http://localhost:3000`, 

but replace `3000` with the port number the app will mention.

with following workflow:

![](./doc/cover.gif)