Real Estate React Dashboard

A React web application to manage real estate connected to an express API in which you can Create, Read, Update and Delete properties (CRUD).

Table of Contents

• Installation
• Quick Start
• Available Scripts
• Technologies
• Want to contribute?

Installation (make it smaller)

Quick Start

Please read Get Started guide for a full version. Common workflow commands include:

Step	Command
1. Clone project	git clone https://github.com/behagoras/dashboard-react
2. Install dependencies	yarn install
3. Configure the apiHost	modify the host in src/config/index.js

For this project we need a backend, you can use the express real estate api for fullfilling the needs:

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

yarn build

Builds the app for production to the docs folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

Full Responsive

The design adapts mobile and desktop.

Technologies

The application was created from scratch using:

• React Js
• Styled Components
• React Final Form
• React Router
• React Dropzone Component
• Javascript ES-2018
• Custom Eslint based on AirBnb
• Custom Webpack
• Custom Babel

Connected to an express API using:

• Node JS
• Express
• Mongo Db Atlas
• GCP storage
• Zeit Now for deployment

Development

Want to contribute? Great!

To fix a bug or enhance an existing module, follow these steps:

• Fork the repo
• Create a new branch (git checkout -b improve-feature)
• Make the appropriate changes in the files
• Add changes to reflect the changes made
• Commit your changes (git commit -am 'Improve feature')
• Push to the branch (git push origin improve-feature)
• Create a Pull Request

Bug / Feature Request

If you find a bug (the website couldn't handle the query and / or gave undesired results), kindly open an issue here by including your search query and the expected result.

If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.

API documentation

For complete documentation of the express API watch the project in Express Real Estate API.

Made with ❤️ by David Behar