API blueprint

A template is for building a HTTPServer purpose codebase. It is influenced Clean Architecture and featuring Simplicity, Flexibility in mind

Getting started

• Install make utility command
• Install go compiler with the latest release
• Install air for hot reloading
• Install python compiler with the latest release
• Replace your project name with the default name
• Install virtual env (assume python installed, skip if already installed)

python3 -m venv venv

• Activate virtual env

For Windows:

./venv/bin/Activate

For Linux/MacOs:

source ./venv/bin/activate

• Install pre-commit

pip install pre-commit
pre-commit install

• Change config.yaml to an appropriate configuration.
• Find TODO comments in the source code and follow guidance

What's next

For further customization, please learn the source code as it's designed with Simple mindset at first.

• Install protoc compiler if you need grpc
• Install swag command if you need Restful API Documentation served by Swagger Spec
• Install docker command if you need to build an image (Dockerfile also provided out of the box)

Contributions

Please fire pull requests if you get any bright ideas.