gin-templates

README

Gin Templates

---

Our templates offer a rich boilerplate to jump start Go Gin-based application development.

Check this wiki for more information about the template structure.

Get Started

Prerequisite

• Python interpreter
• Cookiecutter
  • Mac: brew install cookiecutter
  • Debian/Ubuntu: sudo apt-get install cookiecutter
• Go version >= 1.20

Usage

• Download latest version of gin-templates.

  go get github.com/nimblehq/gin-templates
  

• Build the binary file.

  go build -o $GOPATH/bin/nimble-gin github.com/nimblehq/gin-templates
  

• Create the project using gin-templates. Note that the main branch is being used by default. Refer to this wiki page for instructions on how to use a different branch.

  nimble-gin create
  

• Follow the instructions in the terminal.

• Your new application is created 🎉 .

Test

make test

Development

• Build the command with

  go build -o <PATH_TO_STORE_BUILD_FILE>
  

• Run the build file follow by the create command and the prompt to create a Go project should appear

  <PATH_TO_STORE_BUILD_FILE> create
  

License

This project is Copyright (c) 2014 and onwards Nimble. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

This project is maintained and funded by Nimble.

We love open source and do our part in sharing our work with the community! See our other projects or hire our team to help build your product.

Documentation

Overview

Copyright (c) 2014 and onwards Nimble.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.