Skip to content

Commit

Permalink
feat: readme, branding and some labeling update
Browse files Browse the repository at this point in the history
  • Loading branch information
luifermoron committed Mar 25, 2024
1 parent 7066f9a commit 0bde2c8
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 13 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Welcome to Easy RS 👋
# Welcome to Easy RE 👋

![Version](https://img.shields.io/badge/version-0.9.0-blue.svg?cacheSeconds=2592000)
![Version](https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000)
![Prerequisite](https://img.shields.io/badge/node-%3E%3D18.3.0-blue.svg)
![Prerequisite](https://img.shields.io/badge/yarn-%3E%3D1.22.0-blue.svg)
![Prerequisite](https://img.shields.io/badge/npm-please-use-yarn-blue.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)

> 👌The easy open-source way to manage your Real Estate 🏠 stuff
Easy RS is a self-hosted property management app targeted for developers. Control your real estate portafolio with this easy and open-source solution. With this app you can:
Easy RE is a self-hosted property management app targeted for developers. Control your real estate portafolio with this easy and open-source solution. With this app you can:

- Really easy to setup.
- Manage your properties and tenants with details.
Expand All @@ -25,6 +24,7 @@ Easy RS is a self-hosted property management app targeted for developers. Contro

## Table of Contents

- [Prerequisites](#prerequisites)
- [Install](#install)
- [Dev](#dev)
- [Prod](#prod)
Expand All @@ -33,6 +33,9 @@ Easy RS is a self-hosted property management app targeted for developers. Contro
- [Extra Configurations](#extra-configurations)
- [Seeders](#seeders)
- [Tests](#tests)
- [Contributing](#contributing)
- [Guidelines](#guidelines)
- [Technical hightlights of the project](technical-hightlights-of-the-project)
- [Author](#author)
- [Show your support](#show-your-support)

Expand Down Expand Up @@ -131,6 +134,18 @@ docker exec main yarn test

There is always a gap of improvement, a way to make it easier. That is the purpose of it, make a real estate app usefull and easy to use. And of course, having fun coding :D

## Contributing

### Guidelines

The pull requests will be accepted only under the develop branch.Your code will be lincesed under the current license of the project.

### Technical hightlights of the project

This app uses following technologies: Next JS, React, Docker, Typescript, Ansible, and Husky. No CSS framework until the moment but who knows in the future.

We made this project using the (or at least try) Clean Architecture based on [famous book](https://www.amazon.com/Clean-Architecture-Craftsmans-Software-Structure/dp/0134494164) and [a good article](https://daslaf.dev/posts/arquitectura-clean-react) by [@daslaf](https://github.com/daslaf).

## Author

👤 **Luis Morón**
Expand Down
2 changes: 1 addition & 1 deletion lib/controllers/LeaseContractController.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ async function getTableLeaseContracts(
): Promise<TableMapping<ILeaseContractTable>> {
const labelsMapping: ILeaseContractTable = {
name: 'Name',
amount: 'Amount',
amount: 'Rent Amount',
description: 'Description',
startDate: 'Start Date',
nextDate: 'Next Date',
Expand Down
14 changes: 7 additions & 7 deletions lib/controllers/PropertyController.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ async function getTableProperties(): Promise<TableMapping<IPropertyTable>> {

const labelsMapping: IPropertyTable = {
name: 'Name',
measure: 'Measure',
amount: 'Amount',
measure: 'Square Meters',
amount: 'Rent Amount',
location_details: 'Location Details',
coordinates: 'Coordinates'
};
Expand Down Expand Up @@ -73,12 +73,12 @@ async function allOccupancyRate() {
}

export {
getProperties,
getTableProperties,
getFormFields,
allOccupancyRate,
createProperty,
getFormFields,
getProperties,
getProperty,
updateProperty,
getTableProperties,
removeProperty,
allOccupancyRate
updateProperty
};
2 changes: 1 addition & 1 deletion pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const Home: NextPage<IndexTaskProps> = (tasksProps: IndexTaskProps) => {
<div className={styles.mainContainer}>
<div className={styles.messageContainer}>
<p className={styles.welcomeText}>
Welcome to <strong>Easy RS</strong>!. The easy open-source way to
Welcome to <strong>Easy RE</strong>!. The easy open-source way to
manage your Real Estate 🏠 stuff
<br /> <FaRegLightbulb />
&nbsp; Start creating a lease for managing your properties. Press
Expand Down
Binary file modified public/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0bde2c8

Please sign in to comment.