gommerce

README

Gommerce

⚠️WIP⚠️

Description

RESTful API for a simple e-commerce web service written in Go programming language. This is a capstone project for Project-Based Internship at Evermos.

It uses Fiber as the web framework, GORM as the ORM library, and MySQL as the database. It also utilizes Zap as the logger, Viper as the configuration manager, Gomock as the mocking library, and Ginkgo as the testing framework.

Getting Started

1. Ensure you have Go 1.21.3 or higher and Task installed on your machine:

   go version && task --version
   

2. Install all required tools for the project:

   task install
   

3. Create a copy of the .env.example file and rename it to .env:

   cp .env.example .env
   

   Update configuration values as needed.

Documentation

For database schema documentation, see here, powered by dbdocs.io.

API documentation is on progress.

Contributing

Developers interested in contributing to Gommerce project can refer to the CONTRIBUTING file for detailed guidelines and instructions on how to contribute.

License

Gommerce project is licensed under the MIT License, providing an open and permissive licensing approach for further development and usage.

Learning References

• The Clean Architecture by Uncle Bob
• go-clean-arch by Bxcodec
• go-clean-template by Evrone