health-checker

README

Health Checker CLI

Easy to use CLI tools to check dependant services before running your project!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Installation
• Usage
• Roadmap
• Contributing
• Contact

About The Project

Sometimes it's annoying to check the system status of the services needed by your project, this cli project will simplify your way to check the services you need in your project.

Currently we have:

• MySQL's checker
• Redis's checker
• PostgreSQL's checker

Of course, we will add more to that list, we're waiting for your help.

Built With

This project is build with love and :

• Go
• Cobra

Getting Started

Before you run and install this project, your go version should be higher than 1.10

Installation

1. Clone the repo

git clone https://github.com/LabKom-Unila/health-checker.git

1. Install GO packages

go mod download

1. Build your go app

go build .

1. Add to your path

Usage

Use flag -h or --help to know all the list command.

checker -h

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Project Link: https://github.com/LabKom-Unila/health-checker

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Arham Awal Abiyan 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Documentation

Overview

Copyright © 2020 NAME HERE <EMAIL ADDRESS>

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.