Logo

MIT License GitHub commit activity (branch) Static Badge GitHub go.mod Go version GitHub Tag GitHub Release GitHub Repo stars

Appendix

This is the backend layer of hexal manager system, hexal manager is a enterprise software to manage all the things about residential management, things like issues, tasks, incidents, meets, notes and everything that someone wants to manage with this software are possible

Features

  • Concurrency
  • Mutex/ RWLock and RWUnlock
  • Multiple persistence drivers
  • Highly available services
  • Clean Architecture
  • SQLC techniques
  • Myslq, Postgresql and MongoDB
  • Microservices
  • Docker

Dependecies

  • require
  • fake "only for tests"
  • testify
  • lib/pq
  • net
  • encoding/json
  • gin
  • gorilla/websocket
  • gorilla/mux

Deployment

To deploy this project run

1- First download all the dependecies:

  go mod download

2- Compile the app:

  go build main.go

3- Run the app:

  ./hexal_manager

And always make sure about the dependecies version, sometimes one project might fail because of a deprecated dependency.

API Reference

I am going to show you just 2 enpoints to consume the API.

Get all issues

  GET /api/${company_name}/${project}/issues
Parameter Type Description
x-token string Required. Your Auth token
company_name string Required. Name of the company or enterprise
project string Required. It is required to give a project

Get issue

  GET  /api/${company_name}/${project}/issues/${id}
Parameter Type Description
x-token string Required. Your Auth token
company_name string Required. Name of the company or enterprise
project string Required. It is required to give a project
id string Required. Id of issue to fetch

Support

For support, email juandiego.castellanosjerez@gmail.com