Skip to content

Commit 409890b

Browse files
author
Camel Aissani
committed
updated readme
1 parent 91e46c5 commit 409890b

15 files changed

+105
-42
lines changed

‎DEVELOPER.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Microrealestate
2+
3+
Microrealestate is a set of microservices which work together to offer an open source application for property management.
4+
5+
This application draws its fundamentals from a monolithic application: [Loca](https://github.com/camelaissani/loca)
6+
7+
The first objective is to combine the monolith application and the microservices to provide new functionalities.
8+
9+
![overview](./picture/overview.png)
10+
11+
| µService | Description | Status |
12+
| :-------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | :-------------: |
13+
| [API Gateway](./config/nginx) | Routes HTTP requests to the services (NGINX) | Available |
14+
| [Frontend](https://github.com/microrealestate/frontend) | The web application | Dev in progress |
15+
| [Authenticator](https://github.com/microrealestate/authenticator) | Handles login/logout and tokens management | Available |
16+
| [EMailer](https://github.com/microrealestate/emailer) | Generates and sends emails with [mailgun](https://www.mailgun.com/) | Available |
17+
| [Loca](https://github.com/camelaissani/loca) | Exposes UI API and core engine (former web application) | Available |
18+
| [PDFGenerator](https://github.com/microrealestate/pdfgenerator) | Generates PDF documents (letters, contracts, invoices...) | Available |
19+
| Messages | message broker | Not available |
20+
| Alert | Sends alert messages based on business rules (contract deadlines, unpaid rents...) | Not available |
21+
| Text | Generates and texts (cash balance, alerts...) | Not available |
22+
23+
24+
In a second stage, the monolith application (Loca) will be deprecated and the API and the core engine will be moved in a dedicated repository.
25+
26+
## Debugging the application
27+
28+
### Prerequisite
29+
- Docker and docker-compose installed
30+
> The `mre` bash script is uses for building, running the application. If running on Windows use `mre.ps1`.
31+
32+
33+
You would need to have the latest version of [VS Code](https://code.visualstudio.com/) installed.
34+
35+
Then bring up the Debug view, click on the Debug icon in the **Activity Bar** on the side of VS Code. You can also use the keyboard shortcut `Ctrl+Shift+D`.
36+
37+
![Activity Bar](https://code.visualstudio.com/assets/docs/editor/debugging/debugicon.png)
38+
39+
40+
### Clone the GitHub repository
41+
```shell
42+
$ git clone --recursive https://github.com/microrealestate/microrealestate.git
43+
```
44+
45+
### Go to the microrealestate
46+
```shell
47+
$ cd microrealestate
48+
```
49+
50+
### Launch the application in development mode:
51+
52+
```shell
53+
$ ./mre dev
54+
```
55+
56+
Next, go to the debug bar:
57+
58+
![Activity Bar](https://code.visualstudio.com/assets/docs/editor/debugging/launch-configuration.png)
59+
60+
Then select one of these values to attach the VS Code debugger to the application:
61+
62+
- `Docker: Attach to Loca` (Exposes the UI API and core engine)
63+
- `Docker: Attach to Authenticator` (Handles the authentication)
64+
- `Docker: Attach to Emailer` (Sends emails)
65+
- `Docker: Attach to PdfGenerator` (Generates PDF documents)
66+
67+
For more information about VS Code debugging go [here](https://code.visualstudio.com/Docs/editor/debugging#_debug-actions)

‎README.md

+37-41
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,37 @@
22

33
# Microrealestate
44

5-
Microrealestate is a set of microservices which work together to offer an open source application for property management.
5+
## Features
66

7-
This application draws its fundamentals from a monolithic application: [Loca](https://github.com/camelaissani/loca)
7+
This project is a set of services and a web application to help the landlords manage their properties: buildings, flats, offices, meeting rooms, car parks, letter boxes...
88

9-
The first objective is to combine the monolith application and the microservices to provide new functionalities.
9+
The main functionalities of this project are:
1010

11-
![overview](./picture/overview.png)
11+
- Gather all information of the properties and the tenants in one place
12+
- Create rent leases from templates
13+
- Follow the rents month after month and manage the recovery of the amounts not received
14+
- Create custom documents (letters, emails) to easily communicate with tenants
15+
- Manage the real estate business with several collaborators and organizations
1216

13-
| µService | Description | Status |
14-
| :-------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | :-------------: |
15-
| Alert | Sends alert messages based on business rules (contract deadlines, unpaid rents...) | Not available |
16-
| API Gateway | [NGINX](https://github.com/microrealestate/authenticator.git) | Available |
17-
| [Authenticator](https://github.com/microrealestate/authenticator) | Handles login/logout and tokens management | Dev in progress |
18-
| cAdvisor | [Container Advisor](https://github.com/google/cadvisor) | Available |
19-
| Elastic Stack | [Elasticsearch Logstash Kibana](https://www.elastic.co//products) handles logs and monitors containers and hosts | Available |
20-
| [EMailer](https://github.com/microrealestate/emailer) | Generates and sends emails with [mailgun](https://www.mailgun.com/) | Available |
21-
| [Loca](https://github.com/camelaissani/loca) | The web application | Available |
22-
| Messages | message broker | Not available |
23-
| [PDFGenerator](https://github.com/microrealestate/pdfgenerator) | Generates PDF documents (letters, contracts, invoices...) | Available |
24-
| Text | Generates and texts (cash balance, alerts...) | Not available |
17+
## Screenshots
2518

19+
Rents page | Send notices, receipt by email | Pay a rent |
20+
:-------------------------:|:-------------------------------:|:----------------------:|
21+
[<img src="./picture/rents.png" alt="drawing" width="350"/>](./picture/rents.png) | [<img src="./picture/sendmassemails.png" alt="drawing" width="350"/>](./picture/sendmassemails.png) | [<img src="./picture/payment.png" alt="drawing" width="350"/>](./picture/payment.png)
22+
23+
Tenants page | Tenant details |
24+
:-------------------------:|:------------------------------:|
25+
[<img src="./picture/tenants.png" alt="drawing" width="350"/>](./picture/tenants.png) | [<img src="./picture/tenantcontract.png" alt="drawing" width="350"/>](./picture/tenantcontract.png)
26+
27+
Properties page | Property details |
28+
:-------------------------:|:------------------------------:|
29+
[<img src="./picture/properties.png" alt="drawing" width="350"/>](./picture/properties.png) | [<img src="./picture/property.png" alt="drawing" width="350"/>](./picture/property.png)
30+
31+
32+
Landlord page | Template leases | Author a contract | Members |
33+
:-------------------------:|:------------------------------:|:---------------------------:|:------------------------------:|
34+
[<img src="./picture/landlord.png" alt="drawing" width="350"/>](./picture/landlord.png) | [<img src="./picture/leases.png" alt="drawing" width="350"/>](./picture/leases.png) | [<img src="./picture/contracttemplate.png" alt="drawing" width="350"/>](./picture/contracttemplate.png) | [<img src="./picture/members.png" alt="drawing" width="350"/>](./picture/members.png)
2635

27-
In a second stage, the monolith application will be broken in microservices.
2836

2937
## Getting started
3038

@@ -56,37 +64,25 @@ $ ./mre start
5664
At the end, it displays the application links:
5765

5866
```shell
59-
Front-end http://localhost:8080
60-
kibana http://localhost:9000
61-
cadvisor http://localhost:9100
67+
Front-end http://localhost:8080/app
68+
Deprecated Front-end http://localhost:8080
6269
```
6370

6471
### Run the user interface
6572

66-
Take your favorite internet navigator and go to this link: http://localhost:8080
67-
68-
## Debugging the application
69-
70-
You would need to have the latest version of [VS Code](https://code.visualstudio.com/) installed.
73+
Take your favorite internet navigator and go to this link: http://localhost:8080/app
7174

72-
Then bring up the Debug view, click on the Debug icon in the **Activity Bar** on the side of VS Code. You can also use the keyboard shortcut `Ctrl+Shift+D`.
73-
74-
![Activity Bar](https://code.visualstudio.com/assets/docs/editor/debugging/debugicon.png)
75-
76-
In a terminal launch the application in development mode:
77-
78-
```shell
79-
$ ./mre dev
80-
```
75+
## Community
8176

82-
Next, go to the debug bar:
77+
* Contribute on [Issues](https://github.com/microrealestate/microrealestate/issues)
78+
* [Run and debug the application](./DEVELOPER.MD)
8379

84-
![Activity Bar](https://code.visualstudio.com/assets/docs/editor/debugging/launch-configuration.png)
80+
## Contact
8581

86-
Then select one of these values to attach the VS Code debugger to the application:
82+
* LinkedIn: [www.linkedin.com/in/caissani](https://www.linkedin.com/in/caissani/)
83+
* twitter: [@camelaissani](https://twitter.com/camelaissani)
84+
* website: https://www.nuageprive.fr/
8785

88-
- `Docker: Attach to Loca` (The web application)
89-
- `Docker: Attach to Emailer` (Generates and sends emails)
90-
- `Docker: Attach to PdfGenerator` (Generates PDF documents)
86+
## License
9187

92-
For more information about VS Code debugging go [here](https://code.visualstudio.com/Docs/editor/debugging#_debug-actions)
88+
MIT License

‎loca

Submodule loca updated 1 file

‎picture/contracttemplate.png

140 KB
Loading

‎picture/landlord.png

48.7 KB
Loading

‎picture/leases.png

51.9 KB
Loading

‎picture/members.png

52.8 KB
Loading

‎picture/overview.png

125 Bytes
Loading

‎picture/payment.png

77.8 KB
Loading

‎picture/properties.png

62.4 KB
Loading

‎picture/property.png

204 KB
Loading

‎picture/rents.png

103 KB
Loading

‎picture/sendmassemails.png

46 KB
Loading

‎picture/tenantcontract.png

96.4 KB
Loading

‎picture/tenants.png

86.1 KB
Loading

0 commit comments

Comments
 (0)