ArturTkaczuk/real-estate-classifieds-website

Real estate classifieds CRUD app: https://home-estates-ea790.web.app

Real estate classifieds CRUD app (12.08.22)

CRUD app (CRA-TypeScript build). Check it Live here

Table of Contents

• Requirements
• Installation
• Usage
• Technologies
• Features
• Support
• Contributing
• License

Requirements

• Latest web browser to run app on website (Google Chrome)
• To run git commands you need Git installed
• To run npm commands you need node installed

Installation

a) Download project via git

Run commands in terminal:

git clone https://github.com/ArturTkaczuk/real-estate-classifieds-website.git
cd real-estate-classifieds-website
npm install

b) Download project manually from GitHub

1. Download project from this link
2. Unzip file
3. Open terminal in project's directory and run npm install

Usage

Useful npm scripts - run in project's directory:

Servers and build:

1. Dev server npm run watch:dev
2. Build server npm run watch:prod
3. Production build npm run build:prod

Code formatting scripts

1. Lint project's code with eslint npm run lint
2. Fix all linter's warnings npm run lint:fix
3. Format project's code with prettier npm run format:prettier

Deploying to firebase:

1. Deploy script npm run deploy

Technologies

Technologies used during development process:

• Create-react-app-typescript
• Material UI v5
• eslint-prettier
• React router v6
• Firebase

Features

• CRUD operations

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

You can check out the full license here.

This project is licensed under the terms of the MIT license.