DamyanBG / real-estate-react-app

Real Estate front end application
https://real-estate-react-app.onrender.com
GNU General Public License v3.0
26 stars 45 forks source link

Better README #63

Closed DamyanBG closed 1 year ago

DamyanBG commented 1 year ago

We need to improve our README.

Cleyfson commented 1 year ago

i would like work on it

DamyanBG commented 1 year ago

I am really glad that you want to help! Give me 5 minutes and I will write more description!

DamyanBG commented 1 year ago

So, first you can browse some examples of README and then to make here the README by template.

Usually I want first to introduce that I am the owner of the project and I am responsible for the architecture. After that mention that Tihomir is my buddy, who is learning and helping with the project at the same time. After that mention that there are a lot of contributors and I am grateful for that.

Write in new place that if some of the contributors wants to be mentioned in the README to tell me.

After that write the idea of the application - first we are here to learn and practice. This is perfect project for people with not so much experience in React. Mention if somebody wants to contribute - to open the CONTRIBUTIN.md file.

After that write the description for the business idea behind the app - we are creating an Real Estate Sell and Buy application, which will be open for everyone to use. There will be buyers, sellers and admins in this app. I think it is understandable - buyers just browse and buy, sellers are uploading real estates for sell. Admins to watch what is going on.

DamyanBG commented 1 year ago

After that we will mention where is the difference in our app - at the first time we will make functionality buyers and sellers to be able to chat. We will make functionality buyers and sellers to schedule meetings. After that we will make functionality to make visitations - a visitations will me some kind of open time for going to see some home for selling. The idea is that some sellers can not have time to meet with each buyer and he will spend for example 3 hours on Saturday to unlock the home and show it. At this time everybody can go and see it. Thats the idea behind visitation.

DamyanBG commented 1 year ago

There will be section too for news related to Real Estate, there will be map of Homes for sale. Also we will implement the same thing for Land. If somebody wants to buy or sell Land - he can do the same thing.

In the future we will implement Rent section - there the main logic for now is to give home for rent or take it for rent.

DamyanBG commented 1 year ago

at the end just write how to start the application - the steps:

You can add and link to the back end and to the deployed front end - https://mango-plant-0117d3e03.2.azurestaticapps.net/

Cleyfson commented 1 year ago

this is what i have right now, what do you think?

Captura de tela de 2023-01-05 18-30-04 Captura de tela de 2023-01-05 18-34-24

DamyanBG commented 1 year ago

Awesome!

DamyanBG commented 1 year ago

I like it very much!

Cleyfson commented 1 year ago

to present the details that differentiate the application, I thought of creating a checklist similar to the one below. That can be marked as the functionalities are finished.

Project Status

If you can come with a better list of features already done and that you pretend to do in the feature, i can put it on. Or do you think that i can follow with the list above?.

DamyanBG commented 1 year ago

The list is ok

DamyanBG commented 1 year ago

Very good work! Thank you for the effort!