Skip to content

Latest commit

 

History

History
228 lines (166 loc) · 10.9 KB

README.md

File metadata and controls

228 lines (166 loc) · 10.9 KB
Raw
ci_status ci_status sonar codacy DeepSource go_report_card codecov circleci go.dev gouse_functions_count GitHub code size in bytes license

🧠 Why Gouse?

  • Gouse is a modern essential Golang utility package delivering consistency, modularity, performance, & extras presets inspired by Lodash.
  • Javascript user-friendly syntax.
  • No config - import as utility functions.
  • Lightweight package: easy to use, chainable, and extendable, and available in various builds & module formats.
  • Gouse provides a wide variety of available methods, taking the hassle out of working with arrays, numbers, objects, strings, etc. Each method has different features, so you can pick the ones that fit your project best.
  • Comprehensive documentation and examples.
  • Powerful package that is suitable for small to large projects and compatible with all OS platforms
  • Thanks to Gouse, you can:
    • Set up and scale projects rapidly.
    • Handle complex logic use-cases such as database connection, build APIs, error handling, log management...
    • Optimize performance and increase productivity.
    • Build easily consistent systems with available functions.
    • Avoid writing repetitive code and a unified code style.
    • Reduce the number of lines of code and make it easier to read, understand, and maintain.
    • Avoid compatibility conflicts and unexpected errors.
    • And more...

✨ Motivation

  • Go has emerged as a server language, but it still doesn't have complete and consistent packages available to support coding development.
    • Developers must write by hand or search manually. That wastes time and even causes many compatibility conflicts
    • Must update each dependent package every time you update
    • Unexpected errors can easily arise during execution
    • Performance is not optimized
    • The number of lines of code is very long that not easy to read and understand
    • Code logic may not be consistent, making it difficult to maintain and scale

👉 To address that need, Gouse was created as a powerful toolkit for Go developers, a collection of built-in functions and best practices that provide comprehensive, powerful, and reliable solutions. Trusted to build services, APIs, and web applications.

🚀 Features

Below is a list of modules that Gouse supports. This project is still in development stage, so not all features are available.

✅ Array
✅ Cache
✅ Chart
✅ Config
✅ Connection
✅ Console
✅ Date
✅ Function
✅ Helper
✅ I/O
✅ Log
✅ Math
✅ Net
✅ Number
✅ Regex
✅ Struct
✅ String
✅ Tool
✅ Type

📋 Requirements

Compatibility with Go >= 1.18

📦 Installation

go get github.com/thuongtruong1009/gouse

🕯️ Quick Start

package main

import "github.com/thuongtruong1009/gouse"

func main() {
    gouse.Stater()
}

🦄 Usage

  • Using package directly in your module as ultra-lightweight utility functions.
package main

import (
    "fmt"
    "github.com/thuongtruong1009/gouse/math"
)

func main() {
    fmt.Println(math.Add(1, 2))
}
  • View more examples at sample folder.

📖 Documentation

  • To read the completely package documentation guide, reference at Dev package

📊 Benchmark

GOOS: windows

GOARCH: amd64

CPU: AMD Ryzen 5 5600U with Radeon Graphics (12) @ 2.300GHz

ITERATIONS: 5

INPUT: 1000000

📁 Project Structure

Project Structure

🛠️ Development

$ git clone https://github.com/thuongtruong1009/gouse.git

📝 Contributing

  • We welcome your contributions! If you're looking for issues to work on, try looking at the good first issue list. We do our best to tag issues suitable for new external contributors with that label, so it's a great way to find something you can help with!

  • Please read our Code of Conduct before contributing.

  • Refer to the Contributing Guide for more information on how to get started.

📄 License

  • Gouse is released under the MIT License. See the LICENSE file for more information.

  • For more information, see the Licensing FAQs.

📌 Support

  • The tool has been tested on a variety of inputs, but it's not perfect.
  • For support in using Gouse, please reach out in the following venues:
    • Raise Issues - For generally applicable issues and feedback.
    • Join Discussions - For ideas, questions, or issues regarding Gouse's design, development, and future.

📜 Changelog

  • Gouse is under active development. This means that new features, bug fixes, and breaking changes will be released frequently. We encourage you to keep the CHANGELOG open while upgrading to see what's new!

  • For more information on how to use the changelog, please refer to Keeping a Changelog.

🌸 Sponsor

  • If you like this project, you can sponsor me on:

Github sponsor Paypal Kofi

📮 Contact

  • If you have any questions, please contact me:

Email Github Linkedin Facebook

🧬 Dependencies

  • Gouse is built on top of the following below and others open-source projects

  • Special thanks to the following dependencies that helped make this project possible:

    • Google UUID - A fast and simple UUID library for Go 🔑
    • Survey v2 - A golang library for building interactive prompts with full support for windows and posix terminals 🙋
    • Bubbletea - A powerful little TUI framework 🏗
    • Go Cache - An in-memory key:value store/cache (similar to Memcached) 🗄
    • Crypto - A collection of cryptographic algorithms and protocols for Go 📦
    • Go eCharts - 🎨 The adorable charts library for Golang 📊
    • Env config x Go Toml - A Go library for managing configuration data from files 📄
    • Minio Client Go - MinIO Go Library for Amazon S3 compatible cloud storage 📦

📚 References