Skip to content

Latest commit

 

History

History
218 lines (149 loc) · 7.69 KB

README.md

File metadata and controls

218 lines (149 loc) · 7.69 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Go Starter Template

A boiler plate for your Go project with best practices
📘 Explore the docs »

📅 Book a meeting · 🐛 Report Bug · 🔨 Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact
  7. Contributors
  8. Acknowledgments
  9. Thank You

About The Project

Go Starter Template

This is a starter template for your go based projects. It is supercharged with latest technologies like bazel, grpc, linters, and much more. The new updates related to features, bug fixes, and securities will keep on adding with newer version of the template. The detailed version can be found on project website.

(back to top)

Built With

Go
Bazel
docusaurus

(back to top)

Getting Started

The repository contains the structures and tools that can be used to initialize your go project.

Prerequisites

There is an interactive bash script named main.bash located inside the scripts folder, that will install all the required dependencies and logs the information in log directory. You can run it by running below command from the project root.

./scripts/main.bash

Installation

The installation will be available after the first release of the product. Currently, you can use this as a template, by clicking the top icon and use template.

Usage

Choose the option Use this template for your new project as a boilerplate for it.

Use This Template

For more information, please refer to the Documentation

(back to top)

Roadmap

  • Add database layer
    • Add goose for migration
    • Add sqlc for code generation
  • Add queue using nats
  • Enhance bash scripts
  • Add CLI to generate this template
    • Add subcommand for help

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Discord Server - Go Starter Template

Project Link: https://github.com/sarvsav/go-starter-template

(back to top)

Contributors

Big thanks to our contributors.

Made with contrib.rocks.

Kindly refer to the contributing guide to contribute to the project.

(back to top)

Adopters

📢 If you're using go-starter-template in your organization, please add your name or company name to this list.

By adding yourself to the ADOPTERS.md file, you help increase the project's visibility and credibility, which is essential for its growth.

(back to top)

Acknowledgments

(back to top)

Thankyou

If you appreciate this project, please consider showing your support by ⭐ starring it, 🔄 sharing it with your friends, or 💖 making a donation. Thank you!