mirror of
https://github.com/bluewave-labs/Checkmate.git
synced 2026-01-02 23:59:37 -06:00
GITBOOK-20: No subject
This commit is contained in:
committed by
gitbook-bot
parent
bdeb33b8d3
commit
308e884b36
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 12.13.55 PM.png
Normal file
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 12.13.55 PM.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 216 KiB |
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 12.17.44 PM.png
Normal file
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 12.17.44 PM.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 337 KiB |
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 12.20.52 PM.png
Normal file
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 12.20.52 PM.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 160 KiB |
@@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: list-check
|
||||
---
|
||||
|
||||
# Contributing to the code
|
||||
|
||||
We generally follow the [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow model. If you’re not familiar with it, the general steps are
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: diagram-project
|
||||
---
|
||||
|
||||
# General project structure
|
||||
|
||||
The Uptime Manager product uses the MERN stack, which is to say that the project uses:
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: dove
|
||||
---
|
||||
|
||||
# High level overview
|
||||
|
||||
|
||||
@@ -16,8 +20,34 @@ The following diagram describes a typical request to the /auth endpoints.
|
||||
|
||||
The following diagram describes a typical request to the `/monitors` endpoints.
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.13.55 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### JobQueue
|
||||
|
||||
The heart of this application is a `JobQueue` class that wraps a BullMQ `Queue`. \
|
||||
\
|
||||
A `Monitor` is considered a job, when one is created it is enqueued in the `JobQueue`.\
|
||||
\
|
||||
Jobs are handled by a pool of workers in the `JobQueue` and their tasks are executed in the order in which they are enqueued.\
|
||||
\
|
||||
Workers are scaled up and down based on the jobs/worker ratio as jobs are enqueued and dequeued.
|
||||
|
||||
#### **High level overview of the JobQueue**
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.17.44 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### SSL
|
||||
|
||||
SSL is handled by LetsEncrypt and Certbot. This works by Nginx and Certbot sharing the same volume where the certificates are held. The following snippet from the docker-compose.yaml file shows how this works.\
|
||||
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.20.52 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Please see [this guide](https://phoenixnap.com/kb/letsencrypt-docker) for more information on this setup.
|
||||
|
||||
\
|
||||
\
|
||||
\
|
||||
|
||||
|
||||
\
|
||||
|
||||
Reference in New Issue
Block a user