GithubHelp home page GithubHelp logo

go-clean-architecture's Introduction

GO Clean Architecture

Example that shows core principles of the Clean Architecture in Golang projects.

Rules of Clean Architecture by Uncle Bob:

  • Independent of Frameworks. The architecture does not depend on the existence of some library of feature laden software. This allows you to use such frameworks as tools, rather than having to cram your system into their limited constraints.
  • Testable. The business rules can be tested without the UI, Database, Web Server, or any other external element.
  • Independent of UI. The UI can change easily, without changing the rest of the system. A Web UI could be replaced with a console UI, for example, without changing the business rules.
  • Independent of Database. You can swap out Oracle or SQL Server, for Mongo, BigTable, CouchDB, or something else. Your business rules are not bound to the database.
  • Independent of any external agency. In fact your business rules simply don’t know anything at all about the outside world.

More on topic can be found here.

clean

Structure:

4 Dominant layers:

  • Models layer
  • Repository layer
  • Business Logics layer
  • Controller or Handler layer

REST API:

Routes

METHOD URL Description
GET http://localhost:8081/users GetAllUsers
GET http://localhost:8081/user/:id GetUserByID
DELETE http://localhost:8081/user:id DeleteUserByID
POST http://localhost:8081/register Register
POST http://localhost:8081/login Login
PUT http://localhost:8081/user Change Password

PAYLOAD

REGISTER
{
    "first_name" : "Aditya",
    "last_name" : "Erlangga",
    "email" : "[email protected]",
    "password" : "aditya123"
}
LOGIN
{
    "email" : "[email protected]",
    "password" : "aditya123"
}
CHANGE PASSWORD
{
    "id" : 3,
    "old_password" : "aditya123",
    "new_password" :"hi_everyone!"
}

Requirements

  • go 1.19.1

Setup

Do this :

$ git clone https://github.com/adityaerlangga/go-clean-architecture
$ go mod download
$ go run main.go

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.