Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.08 KB

DEVELOPER.md

File metadata and controls

64 lines (45 loc) · 3.08 KB
Raw

Microrealestate

Here is a diagram showcasing the microservices on the backend and the two frontend applications:

drawing

This diagram serves as a helpful guide to understand the overall structure and flow of the application.

Applications and Services Description Development Status
Landlord UI Landlord web application Available
Tenant UI Tenant web application Available
Gateway Exposes UI and services, handles CORS and reverse proxies Available
Authenticator Handles login/logout and tokens management Available
API Landlord REST API Available
tenantApi Tenant REST API Available
EMailer Generates and sends emails with [Gmail] or mailgun Available
PDFGenerator Generates PDF documents (letters, contracts, invoices...) Available
ResetService Uses to erase all data, only active in DEV and CI environments Available

Start the application in DEV mode

Prerequisite

Clone the GitHub repository

git clone https://github.com/microrealestate/microrealestate.git
cd microrealestate

Install de application dependencies

yarn

Run the application in dev mode

yarn run dev

Debug

To access the debug functionality in VS Code, navigate to the debug bar located within the IDE.

Activity Bar

Next, attach the debugger to the service you wish to debug. This will enable you to step through the code and inspect variables, making it easier to identify and resolve any issues.

  • Docker: Attach to Gateway
  • Docker: Attach to Authenticator
  • Docker: Attach to API
  • Docker: Attach to Emailer
  • Docker: Attach to PdfGenerator
  • Docker: Attach to ResetService

For more information about VS Code debugging