EchoPilot-Template

EchoPilot Template

EchoPilot Template offers a quick start and best practices for Go web application development with pre-configured Echo framework templates and CLI tools. It's designed to help developers jumpstart their Echo-based projects by providing a comprehensive structure and essential components out of the box.

Features

• Pre-configured Echo framework setup.
• Ready-to-use CLI tools for common tasks.
• Structured project layout for maintainability and scalability.
• Localization support with ready-to-use language files.
• Basic examples of middleware, models, and routes.

Getting Started

These instructions will help you to get your EchoPilot Template project up and running on your local machine for development and testing purposes.

Prerequisites

• Go 1.x or higher

Installation

1. Install EchoPilot:

   go install github.com/mylukin/EchoPilot@latest
   

2. Create a project:

   EchoPilot create mylukin/example
   

3. Edit .env:

   vim .env
   

4. Run the application:

   make run
   

• Generate language files:

  make generate
  

Run in Docker

docker run -d -p 3000:3000 -v ./.env:/go/app/.env --name myapp EchoPilot/app-api:latest

Project Structure

EchoPilot-Template is organized into several directories, each with a specific purpose:

• app: Contains the core application logic, middleware, and models.
• catalog: Automatically generated language pack file.
• command: Includes CLI commands for tasks like database migration.
• config: Configuration files and constants.
• locales: Localization files for supporting multiple languages.
• public: Static files such as HTML, CSS, and JavaScript.
• routers: Routes and API endpoint definitions.

See the project's tree structure for a detailed layout.

License

This project is licensed under the MIT License - see the LICENSE file for details.