This page is under construction ​

This page is under construction. Please check back later.

Kiyora is a microservice framework for Go. It is designed to make it easier to build scalable, reliable and efficient microservices

If you also have websites and tools that you think are good, welcome to [High-quality resource recommendation] (https://github.com/ItsMyEyes/kiyora_v2/issues/1) to discuss here. We will reply to you after the review, and everyone is very welcome PR!

Introduction ​

/headingTitle

We recommend creating a new app using i-kiyora, which sets up everything automatically for you. To create a project, run:

$ i-kiyora create

On installation, you'll see the following prompts:

_  __  _
 | |/ / (_)  _   _    ___    _ __    __ _
 | ' /  | | | | | |  / _ \  | '__|  / _` |
 | . \  | | | |_| | | (_) | | |    | (_| |
 |_|\_\ |_|  \__, |  \___/  |_|     \__,_|
             |___/
                            Version 1.0.0
-----------------------------------------------------------------------

You are using go version 1.20.5
You are using git version git version 2.34.1.linux.1
Your GOPATH is /home/itsmyeyes/go/projects

-----------------------------------------------------------------------

What is the name of the project? balance_test_framework
What name your github?  ItsMyEyes

-----------------------------------------------------------------------

Your project name is balance_test_framework
Your module is github.com/ItsMyEyes/balance_test_framework
Your path is /home/itsmyeyes/go/projects/balance_test_framework/

-----------------------------------------------------------------------

The prompts will ask you for the following information:

• Project Name: The name of your project. This will be used to name your project's directory and the main module.
• Name your github: The name of your github. This will be used to name your project's github.

After the prompts, i-kiyora create will create a folder with your project name and install the required dependencies. This may take a few minutes. Once it's done, you'll see the following message:

-----------------------------------------------------------------------

Your project is ready to use.
You can run it with the following commands:

$ cd /home/itsmyeyes/go/projects/balance_test_framework/
$ go run ./cmd/http-server/main.go

-----------------------------------------------------------------------

You can now run your project with the following commands:

1. Move to your project directory

cd /home/itsmyeyes/go/projects/balance_test_framework/

2. Run your project

go run ./cmd/http-server/main.go

You should see the following output:

NAME:
   services_name - run services_name-server

USAGE:
   main.exe [global options] command [command options] [arguments...]

VERSION:
   1.0.0 built on 2023-06-08 (commit: 1.0)

DESCRIPTION:
   services_name is a web server for microservice architecture

COMMANDS:
   start
   migrate
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

⚠️ Note ​

• start is the command to run http server and default port is 8080. And you can custom port by change config file in app.yaml.
• migrate is the command to migrate database. And follow this step How To Migrate

/headingTitle

First you must download binary file from Release Page and extract it. next you must set GOPATH enviroment, if you don't know how to set it, you can follow this step How To Setup GOPATH, after all setup done, you can run it by type i-kiyora at terminal or command prompt. but wait you must move to i-kiyora directory first to GOPATH directory if everything is done correctly, you can running it

Move i-kiyora to bin directory ​

First you must move i-kiyora binary file to bin directory, if you don't know how to move file, you can follow this step

$ mv i-kiyora /usr/local/bin

Permissions ​

If you get error like this

$ i-kiyora
bash: i-kiyora: Permission denied

You must give permission to i-kiyora binary file

$ chmod +x /usr/local/bin/i-kiyora

Running I-Kiyora ​

After you move to i-kiyora directory, you can running it by type i-kiyora at terminal or command prompt

$ i-kiyora
NAME:
   ikiyora - run ikiyora

USAGE:
   ikiyora [command] [arguments...]

VERSION:
   1.0.0 built on 2023-06-19 (commit: now)

DESCRIPTION:
   IKiyora is a installation tool for Kiyora

AUTHOR:
   ItsMyEyes - Andi

COMMANDS:
   create   Creating a new project
   add      Add Module / Adapter
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

/headingTitle

We recommend creating a new app using i-kiyora, which sets up everything automatically for you. To create a project, run:

$ i-kiyora create

On installation, you'll see the following prompts:

_  __  _
 | |/ / (_)  _   _    ___    _ __    __ _
 | ' /  | | | | | |  / _ \  | '__|  / _` |
 | . \  | | | |_| | | (_) | | |    | (_| |
 |_|\_\ |_|  \__, |  \___/  |_|     \__,_|
             |___/
                            Version 1.0.0
-----------------------------------------------------------------------

You are using go version 1.20.5
You are using git version git version 2.34.1.apple.1
Your GOPATH is /home/itsmyeyes/go/projects

-----------------------------------------------------------------------

What is the name of the project? balance_test_framework
What name your github?  ItsMyEyes

-----------------------------------------------------------------------

Your project name is balance_test_framework
Your module is github.com/ItsMyEyes/balance_test_framework
Your path is /home/itsmyeyes/go/projects/balance_test_framework/

-----------------------------------------------------------------------

The prompts will ask you for the following information:

• Project Name: The name of your project. This will be used to name your project's directory and the main module.
• Name your github: The name of your github. This will be used to name your project's github.

After the prompts, i-kiyora create will create a folder with your project name and install the required dependencies. This may take a few minutes. Once it's done, you'll see the following message:

-----------------------------------------------------------------------

Your project is ready to use.
You can run it with the following commands:

$ cd /home/itsmyeyes/go/projects/balance_test_framework/
$ go run ./cmd/http-server/main.go

-----------------------------------------------------------------------

You can now run your project with the following commands:

1. Move to your project directory

cd /home/itsmyeyes/go/projects/balance_test_framework/

2. Run your project

go run ./cmd/http-server/main.go

You should see the following output:

NAME:
   services_name - run services_name-server

USAGE:
   main.exe [global options] command [command options] [arguments...]

VERSION:
   1.0.0 built on 2023-06-08 (commit: 1.0)

DESCRIPTION:
   services_name is a web server for microservice architecture

COMMANDS:
   start
   migrate
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

⚠️ Note ​

• start is the command to run http server and default port is 8080. And you can custom port by change config file in app.yaml.
• migrate is the command to migrate database. And follow this step How To Migrate

/headingTitle

First you must download binary file from Release Page and extract it. next you must set GOPATH enviroment, if you don't know how to set it, you can follow this step How To Setup GOPATH, after all setup done, you can run it by type i-kiyora at terminal or command prompt. but wait you must move to i-kiyora directory first to GOPATH directory if everything is done correctly, you can running it

Move i-kiyora to bin directory ​

First you must move i-kiyora binary file to bin directory, if you don't know how to move file, you can follow this step

$ mv i-kiyora /usr/bin

if you get error like this

mv: rename i-kiyora to /usr/bin/i-kiyora: Permission denied

you must run it with sudo command

Permissions ​

You must give permission to i-kiyora binary file

$ chmod +x /usr/bin/i-kiyora

Running I-Kiyora ​

After you move to i-kiyora directory, you can running it by type i-kiyora at terminal or command prompt

$ i-kiyora
NAME:
   ikiyora - run ikiyora

USAGE:
   ikiyora [command] [arguments...]

VERSION:
   1.0.0 built on 2023-06-19 (commit: now)

DESCRIPTION:
   IKiyora is a installation tool for Kiyora

AUTHOR:
   ItsMyEyes - Andi

COMMANDS:
   create   Creating a new project
   add      Add Module / Adapter
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

/headingTitle

Introduction ​

Migrate is a tool that allows you to manage database migrations

Configuration ​

You can configure the database connection in the app.yml file, in the database section

Postgresql:
  Enabled: false
  Host: ''
  Port: ''
  Username: ''
  Password: ''
  Database: ''
  Timeout: 60
  SslMode: disable
  LogLevel: error

Usage ​

after everything is configured, you must must create a new model, for example internal/api/models/user.go

package models

import (
  "time"
)

type User struct {
  Name      string    `json:"name"`
  Email     string    `json:"email"`
  Password  string    `json:"password"`
  CreatedAt time.Time `json:"created_at"`
  UpdatedAt time.Time `json:"updated_at"`
}

then you must add the model to the pkg/database/migrate.go file

var MigrateList Migrates = Migrates{
	&models.User{},
}

last you can run the migrate command

$ ikiyora migrate

/headingTitle

GOPATH is an environment variable used in Go (Golang) programming to specify the workspace directory for Go projects. It defines the root of your Go workspace, which contains the source code for your projects, as well as the compiled binaries and other related files.

Windows (GOPATH) ​

1. Open a command prompt by pressing win + r the enter cmd
2. type at cmd

set GOPATH=c:\Projects

Linux (GOPATH) ​

1. Open a terminal by pressing ctrl + alt + t
2. type at terminal

export GOPATH=$HOME/Projects

Mac (GOPATH) ​

1. Open a terminal by pressing command + space then type terminal
2. type at terminal

export GOPATH=$HOME/Projects

/headingTitle

Prerequisites ​

• Golang - recommend you have either 1.18 or 1.19 installed.
• Git - recommend you have 2.33 or higher installed.
• A text editor, we recommend VS Code with Golang extension.
• A terminal, we recommend using VS Code's integrated.

Download installation package ​

We recommend creating a new app using installation, which sets up everything automatically for you. To create a project, you must download binary file from release page. Or you can download here

💻 Mac (Download) ​

• Mac Amd64
• Mac Arm64

💻 Windows (Download) ​

• Windows Amd64
• Windows Arm64

💻 Linux (Download) ​

• Linux Amd64
• Linux Arm64

/headingTitle

We recommend creating a new app using i-kiyora.exe, which sets up everything automatically for you. To create a project, run:

C:\Projects\Golang> i-kiyora.exe create

On installation, you'll see the following prompts:

_  __  _
 | |/ / (_)  _   _    ___    _ __    __ _
 | ' /  | | | | | |  / _ \  | '__|  / _` |
 | . \  | | | |_| | | (_) | | |    | (_| |
 |_|\_\ |_|  \__, |  \___/  |_|     \__,_|
             |___/
                            Version 1.0.0
-----------------------------------------------------------------------

You are using go version 1.20.5
You are using git version git version 2.34.1.windows.1
Your GOPATH is C:\Projects\Golang

-----------------------------------------------------------------------

What is the name of the project? balance_test_framework
What name your github?  ItsMyEyes

-----------------------------------------------------------------------

Your project name is balance_test_framework
Your module is github.com/ItsMyEyes/balance_test_framework
Your path is C:\Projects\Golang\balance_test_framework\

-----------------------------------------------------------------------

The prompts will ask you for the following information:

• Project Name: The name of your project. This will be used to name your project's directory and the main module.
• Name your github: The name of your github. This will be used to name your project's github.

After the prompts, i-kiyora.exe create will create a folder with your project name and install the required dependencies. This may take a few minutes. Once it's done, you'll see the following message:

-----------------------------------------------------------------------

Your project is ready to use.
You can run it with the following commands:

$ cd C:\Projects\Golang\balance_test_framework\
$ go run ./cmd/http-server/main.go

-----------------------------------------------------------------------

You can now run your project with the following commands:

1. Move to your project directory

cd C:\Projects\Golang\balance_test_framework\

2. Run your project

go run ./cmd/http-server/main.go

You should see the following output:

NAME:
   services_name - run services_name-server

USAGE:
   main.exe [global options] command [command options] [arguments...]

VERSION:
   1.0.0 built on 2023-06-08 (commit: 1.0)

DESCRIPTION:
   services_name is a web server for microservice architecture

COMMANDS:
   start
   migrate
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

⚠️ Note ​

• start is the command to run http server and default port is 8080. And you can custom port by change config file in app.yaml.
• migrate is the command to migrate database. And follow this step How To Migrate

/headingTitle

First you must download binary file from Release Page and extract it. next you must set GOPATH enviroment, if you don't know how to set it, you can follow this step How To Setup GOPATH, after all setup done, you can run it by type i-kiyora at terminal or command prompt. but wait you must move to i-kiyora directory first to GOPATH directory if everything is done correctly, you can running it

Extract I-Kiyora ​

After you download binary file from Release Page, you must extract it. you can extract it with WinRAR or 7-Zip or other software, after you extract it, you can make directory C:\ikiyora and move binary file to C:\ikiyora , if you want to move it to other directory, you can move it to other directory, but you must remember the directory path

Add I-Kiyora to PATH ​

If you want to run I-Kiyora from anywhere, you can add it to PATH, you can follow this step

1. Open the Start menu and search for "Edit the system environment variables" and select the matching result.
2. In the System Properties window that appears, click on the "Environment Variables" button.
3. In the Environment Variables window, you will see two sections: "User variables" and "System variables". To add the directory to the PATH for all users, edit the "System variables" section. To add it only for your user account, edit the "User variables" section.
4. Locate the "Path" variable in the list of variables and select it.
5. Click on the "Edit" button to modify the Path variable.
6. In the Edit Environment Variable window, click on the "New" button.
7. Enter the directory path C:\ikiyora\ or your directory path.
8. Click "OK" to close all the windows.
9. It is important to restart any open command prompt windows or applications for the changes to take effect.

Running I-Kiyora ​

After you move to i-kiyora directory, you can running it by type i-kiyora at terminal or command prompt

C:\Projects\Golang> i-kiyora
NAME:
   ikiyora - run ikiyora

USAGE:
   ikiyora [command] [arguments...]

VERSION:
   1.0.0 built on 2023-06-19 (commit: now)

DESCRIPTION:
   IKiyora is a installation tool for Kiyora

AUTHOR:
   ItsMyEyes - Andi

COMMANDS:
   create   Creating a new project
   add      Add Module / Adapter
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

There is a search function in the upper left corner. If you have front-end problems, you may wish to search and try.

The content of ChoDocs is free and open source, but I also hope that you follow the spirit of open source and do not engage in commercial activities.

If you think the content is good, you might as well support us with star, so that more people can see this high-quality content website.

https://github.com/chodocs/chodocs Give a ⭐️ if this project helped you!

📓 content ​

• 📋 Interview column: Massive front-end interview questions and answers, one-stop reading experience.
• 💬 Programming Learning: Synchronize Bilibili videos, and documents are used to consolidate knowledge.
• 📓 Front-end algorithm: No longer afraid of interview algorithm, provide a route to brush questions.
• 🚚 Memo: Make a memo of the problems encountered in daily work for easy reference.
• 💭 Learning Circle: Create a professional front-end technical atmosphere community, low-key and pragmatic.
• 🔧 Programming tools: Summarize some programming-related tools and websites to improve efficiency.
• 🌱 Green Years: Program the life time machine to record all the good times.
• 🎉Technical vision: follow the cutting-edge technology, learn in depth and breadth.
• 🚩 Embrace open source: The document is open source, the copyright is owned by ChoDocs, and commercial behavior is prohibited.

Learning is like sailing against the current, if you do not advance, you will retreat.

🏠 Sites ​

• 🚀 Based on VitePress, fast response
• ⚡ Expand the Vite ecosystem and integrate Vite PWA
• 📏 Add eslint and git-hooks, automatic formatting and repair
• 🦾 Use TypeScript to ensure type safety
• 📦 Write custom plugins and components, with rich and diverse content
• 🌈 Public contributor avatars to create high-quality content
• 🌏 Establish a learning circle with an excellent learning atmosphere
• 📡 Generate a feed, the content can be subscribed to update
• 📘 Pay attention to content layout and provide a good reading experience
• 🏆 Create one-stop high-quality professional front-end content
• 💡Learning thinking summary and learning dynamic public sharing
• 🍭 Design resource navigation, a useful website for sharing favorites

Disclaimer ​

This site is for the purpose of sharing Internet experience and learning knowledge. The tools and resources used in all articles are from the Internet and are for learning and research purposes only. The copyright belongs to the author. If you inadvertently infringe your copyright Copyright, please write to inform. This site will be deleted as soon as possible! In addition, most of the articles on this site are original bloggers, and most of them are relocated from other platforms such as CSDN, Nuggets, and Official Accounts. They are only for learning and communication, and do not participate in commercial purposes.

In compliance with relevant laws and regulations, since some of the resources on this site come from the Internet, and open-source templates are used for development, it is impossible to verify the authenticity of resource infringement. No matter what the purpose is for this site to delete content, "you"** need to provide relevant proof, otherwise it will not be processed**.