Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/taraslis453/solid-software-task

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/taraslis453/solid-software-task
Owner: taraslis453
Created: 2023-10-06T10:56:13.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-10-06T11:36:53.000Z (over 1 year ago)
Last Synced: 2023-10-07T11:41:20.070Z (over 1 year ago)
Language: Go
Size: 32.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

#### Architecture

**High-Level File Structure**

- `./cmd`: Contains the entry point for the program, allowing users to run and use its features.
- `./config`: Contains configuration files that define the behavior of the program and allow users to customize it to their needs.
- `./internal`: Contains the program's internal logic, the code that dictates how the software works and operates.
- `./pkg`: Incorporates the external logic of the program that can be utilized by other applications to add new features or refine existing ones.

**Internal Architecture**
The internal components of the program are defined by a clean architecture that establishes a high-level hierarchy.

Clean architecture is a software design that helps maintain an organized codebase and promotes development flexibility. For a better understanding of the architecture, it's recommended to read "Clean Architecture" by Robert Martin.

**File Structure of the `internal` Directory**:

- `./app`: Responsible for the program's initialization, and contains code related to the initialization of other levels.
- `./entity`: Represents the core business domain, reflecting the entities of the application and operations on them. It also includes the most critical business rules [high-level module].
- `./service`: Represents the business logic layer, responsible for executing business rules, such as user authentication, registration, etc. [mid-level module].
- `./api`: This layer is responsible for communication with external services [low-level module].
- `./storage`: The storage layer, responsible for performing CRUD operations on the data [low-level module].
- `./controller`: The transport layer, responsible for obtaining input data, passing it to the business logic level, and returning the output result. Here you can find directories like `http`, `pubsub`, and `queue`, as these are all data exchange mechanisms [low-level module].

![](https://blog.cleancoder.com/uncle-bob/images/2012-08-13-the-clean-architecture/CleanArchitecture.jpg)

#### Run locally

To run all necessary services you need to execute a command in the root folder:
`docker-compose --env-file config/.env up --build postgresdb api`

For stop containers and removing all images run command:
`docker-compose down --rmi local`

#### Testing

You can run `sh tests.sh` in the root folder to call endpoints. Note that script requires [jq](https://jqlang.github.io/jq/download/) binary to be preinstalled.