README.md

Gocell

GoCell is a robust and scalable base platform for building web applications using the Go programming language.

Table of Contents

• Gocell
  • Table of Contents
  • Introduction
  • Prerequisites
  • Getting Started
    • Running the REST API Server
    • Building the REST API Server
    • Running the Job Server
    • Building the Job Server
  • Modules Support
    • Running Tests
    • Tidying up Modules
    • Upgrading Dependencies
    • Cleaning Dependency Cache
  • Tools Commands
    • Swagger Documentation
  • Component

Introduction

GoCell is a robust and scalable base platform for building web applications using the Go programming language. It provides a solid foundation with essential features and a modular architecture that allows developers to quickly kickstart their projects and focus on building core functionality.

Prerequisites

Golang version v1.20

Getting Started

Explain how users can get started with Gocell project.

Running the REST API Server

To run the REST API server, use the following command:

make run

This will start the server using the provided configuration files.

Building the REST API Server

To build the REST API server, use the following command:

make build

This will compile the server executable.

Running the Job Server

To run the Job server, use the following command:

make run-job

This will start the Job server using the specified configuration file.

Building the Job Server

To build the Job server, use the following command:

make build-job

This will compile the Job server executable.

Modules Support

Explain how users can interact with the various modules in Gocell project.

Running Tests

To run tests for all modules, use the following command:

make test

Tidying up Modules

To tidy up the project's Go modules, use the following command:

make tidy

Upgrading Dependencies

To upgrade project dependencies, use the following command:

make deps-upgrade

Cleaning Dependency Cache

To clean the Go module cache, use the following command:

make deps-clean-cache

Tools Commands

Swagger Documentation

To generate Swagger documentation, use the following command:

make swaggo

This will initialize Swagger and generate the API documentation.

Component

• Integrated Postgres
• Integrated MySQL
• Integrated RabbitMQ
• Integrated Redis
• Integrated Swagger
• Integrated Websocket
• Integrated base middlewares (CORS, ERROR, ...)
• Integrated Telegram / Slack bot
• Integrated Logger
• Integrating Kafka
• Add Dockerfile
• Add cronjob