|
| 1 | +### <p align="center">EchoFrame</p> |
| 2 | +#### <p align="center">Based on the echo framework, build a convenient scaffolding</p> |
| 3 | +#### <p align="center"><a href="https://github.com/jeffcail/cgncode/releases"><img src="https://img.shields.io/github/release/cgncode/releases.svg" alt="GitHub release"></a><a href="https://github.com/jeffcail/cgncode/blob/master/LICENSE"><img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license"></a><p> |
| 4 | +#### <p align="center"><a href="./README.md" target="_blank">Simplified Chinese</a> | <a href="./README_en.md" target="_blank">English</a> </p> |
| 5 | + |
| 6 | +# EchoFrame |
| 7 | +> This project is a scaffold based on Golang and Echo framework. |
| 8 | +> |
| 9 | +> It aims to provide developers with an efficient and flexible development foundation. |
| 10 | +> |
| 11 | +> The scaffold integrates a variety of powerful functions. |
| 12 | +
|
| 13 | +## Function Points |
| 14 | + |
| 15 | +* Log system: built-in log function, support different levels of logging, convenient debugging and monitoring. |
| 16 | +* XORM: use XORM as ORM library to simplify MySQL database operations and support complex queries. |
| 17 | +* MySQL: integrated MySQL database, providing reliable data storage solutions. |
| 18 | +* Redis: support Redis, provide fast cache and message queue functions. |
| 19 | +* LevelDB: integrated LevelDB, suitable for scenarios requiring efficient key-value storage. |
| 20 | +* MongoDB: support MongoDB, suitable for processing unstructured data and high concurrency scenarios. |
| 21 | +* JWT: implement JSON Web Token authentication to ensure secure user management. |
| 22 | +* Code generator: provide code generation tools, quickly create project structure and templates, and improve development efficiency. |
| 23 | +* gtools tool library: built-in gtools library, provide common tool functions, further simplify the development process. |
| 24 | + |
| 25 | +This scaffold is suitable for developers who need to build applications quickly. It reduces repetitive work and allows you to focus on the implementation of business logic while improving code quality and development efficiency. |
| 26 | +## Download and use function points |
| 27 | + |
| 28 | +### Install Docker |
| 29 | +linux |
| 30 | +```shell |
| 31 | +make linux |
| 32 | +``` |
| 33 | + |
| 34 | +macos |
| 35 | +```shell |
| 36 | +make macos |
| 37 | +``` |
| 38 | + |
| 39 | +### mysql、redis、mongodb、naocs |
| 40 | +```shell |
| 41 | +make env |
| 42 | +``` |
| 43 | + |
| 44 | +### Install Dependencies |
| 45 | +```shell |
| 46 | +make mod |
| 47 | +``` |
| 48 | + |
| 49 | +### run |
| 50 | +```shell |
| 51 | +make run |
| 52 | +``` |
| 53 | + |
| 54 | +### Code Generator |
| 55 | +<a href="./cmd/auto/README.md" target="_blank">简体中文</a> |
| 56 | +| |
| 57 | +<a href="./cmd/auto/README_en.md" target="_blank">English</a> |
| 58 | + |
| 59 | +### Contributions |
| 60 | +Welcome to submit issues and contribute code! |
| 61 | + |
| 62 | +### Support a cup of coffee |
| 63 | + |
| 64 | + |
| 65 | +### License |
| 66 | +This project is licensed under the MIT License. See the LICENSE file for details. |
0 commit comments