README.md

Ideal

The ideal golang project template for newbies.

Report Bug · Request Feature

🌟 About the Project

Sometimes people just want to create a new project in go but aren't sure the how to get started. This project is designed to be the ideal template inspired by 12-factors for go projects with a bit of flair. It's also a fun way to learn go conventions.

📷 Screenshots

TODO Add Image

👾 Tech Stack

ideal

• golang

DevOps

• Docker
• GitHub Actions

🎯 Features

• TODO Add Features

🔑 Config Variables

• TODO : Add Config Variables

🧰 Getting Started

‼️ Prerequisites

This project uses poetry as the python package manager

• TODO Add Install Guide

🏃 Run Locally

TODO: Add GIF

Clone the project

  git clone [email protected]:Mikaayenson/ideal.git

Go to the project directory

  cd ideal

Install dependencies

  TODO Add dependencies

Run ideal

  ideal --help

🧪 Running Tests

Run tests

  go test

🚩 Build: Go Package

Build this project

  go build

🚩 Build: Docker Container

Build this project as a docker container

  docker build --tag ideal_image

Run the ideal commands

  docker run --rm ideal_image ideal version

👀 Usage

  # Run the ideal command
  ideal do stuff

🧭 Lessons Learned & Roadmap

• TODO Add lessons learned

❔ FAQ

• TODO: Add FAQ

⚠️ License

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

🤝 Contact

Mika Ayenson - @mikaayenson

💎 References

1. Selecting a Package Name
2. Leverage an Awesome Readme Template
3. Start organizing Package Layout
4. Add Config Mangement
5. Add Log Management
6. TODO Add More References