k2

README

k2!

English | 简体中文

The front-end and back-end separation authority management system based on Gin + Vue + Element UI is extremely simple to initialize the system. You only need to modify the database connection in the configuration file. The system supports multi-instruction operations. Migration instructions can make it easier to initialize database information. Service instructions It's easy to start the api service.

documentation

Front-end project

Video tutorial

✨ Feature

• Follow RESTful API design specifications

• Based on the GIN WEB API framework, it provides rich middleware support (user authentication, cross-domain, access log, tracking ID, etc.)

• RBAC access control model based on Casbin

• JWT authentication

• Support Swagger documents (based on swaggo)

• Database storage based on GORM, which can expand multiple types of databases

• Simple model mapping of configuration files to quickly get the desired configuration

• Code generation tool

• Form builder

• Multi-command mode

• TODO: unit test

🎁 Internal

1. User management: The user is the system operator, this function mainly completes the system user configuration.
2. Department management: configure the system organization (company, department, group), and display the tree structure to support data permissions.
3. Position management: configure the positions of system users.
4. Menu management: configure the system menu, operation authority, button authority identification, interface authority, etc.
5. Role management: Role menu permission assignment and role setting are divided into data scope permissions by organization.
6. Dictionary management: Maintain some relatively fixed data frequently used in the system.
7. Parameter management: dynamically configure common parameters for the system.
8. Operation log: system normal operation log record and query; system abnormal information log record and query.
9. Login log: The system login log record query contains login exceptions.
10. Interface documentation: Automatically generate related api interface documents according to the business code.
11. Code generation: According to the data table structure, generate the corresponding addition, deletion, modification, and check corresponding business, and the whole process of visual operation, so that the basic business can be implemented with zero code.
12. Form construction: Customize the page style, drag and drop to realize the page layout.
13. Service monitoring: View the basic information of some servers.
14. Content management: demo function, including classification management and content management. You can refer to the easy to use quick start.

Ready to work

You need to install locally [go] [gin] node 和 git

At the same time, a series of tutorials including videos and documents are provided. How to complete the downloading to the proficient use, it is strongly recommended that you read these tutorials before you practice this project! ! !

Easily implement k2 to write the first application-documentation tutorial

Step 1 - basic content introduction

Step 2 - Practical application - writing database operations

Teach you from getting started to giving up-video tutorial

How to start k2

Easily implement business using build tools

v1.1.0 version code generation tool-free your hands [Advanced]

Explanation of multi-command startup mode and IDE configuration

Configuration instructions for k2 menu [Must see]

How to configure menu information and interface information [Must see]

k2 permission configuration instructions [Must see]

Instructions for use of k2 data permissions [Must see]

If you have any questions, please read the above-mentioned usage documents and articles first. If you are not satisfied, welcome to issue and pr. Video tutorials and documents are being updated continuously.

📦 Local development

Development directory creation

# Create a development directory
mkdir goadmin
cd goadmin

Get the code

Important note: the two projects must be placed in the same folder;

# Get backend code
git clone https://github.com/k2-team/k2.git

# Get the front-end code
git clone https://github.com/k2-team/k2-ui.git

Startup instructions

Server startup instructions

# Enter the k2 backend project
cd ./k2

# Compile the project
go build

# Change setting 
# File path k2/config/settings.yml
vi ./config/setting.yml 

# 1. Modify the database information in the configuration file
# Note: The corresponding configuration data under settings.database
# 2. Confirm the log path

:::tip ⚠️Note that this problem will occur if CGO is not installed in the windows environment;

E:\k2>go build
# github.com/mattn/go-sqlite3
cgo: exec /missing-cc: exec: "/missing-cc": file does not exist

or

D:\Code\k2>go build
# github.com/mattn/go-sqlite3
cgo: exec gcc: exec: "gcc": executable file not found in %PATH%

Solve the cgo problem and enter

:::

Initialize the database, and start the service

# The first configuration needs to initialize the database resource information
# Use under macOS or linux
$ ./k2 migrate -c=config/settings.dev.yml

# ⚠️Note: Use under windows
$ k2.exe migrate -c=config/settings.dev.yml

# Start the project, you can also use the IDE for debugging
# Use under macOS or linux
$ ./k2 server -c config/settings.yml

# ⚠️Note: Use under windows
$ k2.exe server -c config/settings.yml

Use docker to compile and start

# Compile the image
docker build -t k2 .


# Start the container, the first k2 is the container name, and the second k2 is the image name
# -v Mapping configuration file Local path: container path
docker run --name k2 -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d k2-server

Generation Document

go generate

Cross compile

# windows
env GOOS=windows GOARCH=amd64 go build main.go

# or
# linux
env GOOS=linux GOARCH=amd64 go build main.go

UI interactive terminal startup instructions

# Installation dependencies
npm install   # or cnpm install

# Start service
npm run dev

JetBrains open source certificate support

The k2 project has always been developed in the GoLand integrated development environment under JetBrains, based on the free JetBrains Open Source license(s) genuine free license. I would like to express my gratitude.

🤝 Thanks

1. chengxiao
2. gin
3. casbin
4. spf13/viper
5. gorm
6. gin-swagger
7. jwt-go
8. vue-element-admin
9. ruoyi-vue
10. form-generator

🤟 Sponsor Us

If you think this project helped you, you can buy a glass of juice for the author to show encouragement 🍹

🤝 Link

Go developer growth roadmap

🔑 License

MIT

Copyright (c) 2021 Netwarps