vision

command module
v0.0.0-...-5b7eff6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2023 License: MIT Imports: 5 Imported by: 0

README

Vision Backend

Installing / Getting started

  1. Ensure you have Git installed on your computer and clone this project using the below command.
git clone https://github.com/AntonyIS/vision.git

The project will be cloned into you machine

Technology stack

  • Golang - Application runtime
  • Go Gin - Go web application framework
  • JWT - For authentication and resource authorization
  • AWS DynamoDB - Store user and projects
  • AWS Timestream Database
  • Docker - Application packaging | Containerization
  • AWS Elasticbeanstalk for deployment to cloud

Application Architecture

This application is made up of the Hexagonal(Ports and Adapter) architecture

├── config
│   └── config.go
├── go.mod
├── go.sum
├── internal
│   ├── adapters
│   │   ├── database
│   │   │   ├── dynamodb
│   │   │   │   └── dynamodb.go
│   │   │   ├── s3
│   │   │   │   └── s3.go
│   │   │   └── timestreamdb
│   │   │       └── timestream.go
│   │   └── http
│   │       ├── gin.go
│   │       ├── handlers.go
│   │       └── middleware.go
│   └── core
│       ├── domain
│       │   └── domain.go
│       ├── ports
│       │   └── ports.go
│       └── services
│           └── services.go
├── LICENSE
├── main.go
├── Makefile
└── README.md
Setting up Dev
  • Clone the application
git clone https://github.com/AntonyIS/vision
  • Navigate into the working directory
cd vision
  • Tidy up the application: install dependancies
go mod tidy
  • Run the application
make serve
  • Run the tests
make test

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
core/domain
Package name : domain Filename : domain.go Description : Host code for application entities : Users, Devices, Company
Package name : domain Filename : domain.go Description : Host code for application entities : Users, Devices, Company
core/ports
Package name : ports Filename : ports.go Description : Host code for application business logic
Package name : ports Filename : ports.go Description : Host code for application business logic
core/services
Package name : services Filename : services.go Description : Host code for business logic implementation
Package name : services Filename : services.go Description : Host code for business logic implementation

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL