Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #38

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/ConfiguringRepos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
For testing purposes the pacman repository can be changed to ones managed by bxt by the following steps:

1. Backup current pacman.conf file:
```bash
sudo cp /etc/pacman.conf /etc/pacman.conf.bak
```

2. Edit pacman configuration to point to the bxt-managed repo:
```ini
[core]
SigLevel = PackageRequired
Server = https://<bxt-server-name>/box/unstable/core/x86_64/

[extra]
SigLevel = PackageRequired
Server = https://<bxt-server-name>/box/unstable/extra/x86_64/

[community]
SigLevel = PackageRequired
Server = https://<bxt-server-name>/box/unstable/community/x86_64/

[multilib]
SigLevel = PackageRequired
Server = https://<bxt-server-name>/box/unstable/multilib/x86_64/
```

This will prevent pacman from using the mirrorlist in favor of bxt.
28 changes: 28 additions & 0 deletions docs/development/ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<div align="center">
<img src="../../frontend/public/logo-full.png" alt="drawing" width="200"/>
</div>

#

<div align="center">
Architecture outline
</div>

## Introduction

This is an overview of the b[x] architecture for daemon components. This should make it easier for contributors to understand the specifics of this project's layout and design.

## Core Components

C++ daemon is developed with Domain-Driven Design principles in mind and split into 3 layers:

- **Domain layer**:
- `core/domain` - business logic (entities, value objects, repositories)
- **Application layer**:
- `core/application` - application layer that is used to orchestrate the business logic (DTOs, Services)
- **Infrastructure layer**:
- `persistence` - persistence logic implementation (databases, configuration)
- `infrastructure` - infrastructure logic implementation (application layer implementations, networking, events, notifications)
- `presentation` - presentation logic (http-controllers, filters, messages)

The code also contains `utilities` directory. It's for various cross-cutting concerns or third-party libraries bindings.