Welcome to Real Estates 👋

An application where you can see real estate with the option to buy it

🏠 Homepage

✨ Demo

Before you begin, ensure you have met the following requirements:

• Install git
• Install nodejs
• Install nvm

Install

To install real estates app, follow these steps:

• Clone the source locally:

  $ git clone https://github.com/Alver23/real-estates.git <project-name>
  $ cd <project-name>

• Installing dependencies:

  $ npm i

Usage

• Enter the project folder:

  $ cd <project-name>

• Mode: development

  $ npm run start

• Mode: production

  $ npm run build
  $ npm install -g serve
  $ serve -s build -l 4000

Running the tests ⚙️

Running unit tests 🔩

The unit test in the app is configuring only to test the logic, not e2e, to generate a test file, only is necessary to add this in <project-name>/src/**/__tests__/ for other withe the format <name>.spec.{ts, tsx}.

$ npm test

Note: If you want exclude or modify test configuration, apply this change in jest.config.js

Running linter 🖋

The project work with ESlint configuration using Prettier as rules template.

$ npm run lint && npm run stylelint

Running Sonarqube

This tool allow run analysis of the project code and check if developer apply best practices and haven't any vulnerabilities in this using Typescript.

Before running this process it is necessary to configure the following environment variables in /.env file:

SONARQUBE_HOST_URL=<Sonarqube URL>
SONARQUBE_TOKEN=<Sonarqube Token>

Run analysis

$ npm run sonarqube

Built with 🛠️

• Create react app
• Testing React: Enzyme
• Testing: Jest
• Formatter: Prettier
• Linter: ESLint
• Linter: Stylelint
• Tailwindcss
• Css with superpwers: Sass
• Conventional Commits
• Standard version
• Git hooks: husky

Author

👤 Alver Grisales Ortega

• Website: https://github.com/Alver23
• Twitter: @23Alver
• Github: @Alver23
• LinkedIn: @alvergrisales

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 Alver Grisales Ortega.
This project is MIT License licensed.

---

This README was generated with ❤️ by readme-md-generator