ruidy/rentease
1
0
Fork 0
mirror of https://github.com/rjNemo/rentease.git synced 2026-06-12 13:46:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve readme

Browse source
This commit is contained in:
Ruidy 2024-11-15 10:20:07 +01:00
parent 6376fbd234
commit c8490bd803
No known key found for this signature in database
GPG key ID: E00F51288CB857CC
1 changed files with 29 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -1,10 +1,19 @@
# Rentease # Rentease
<div align="center"> ![RentEase](assets/icons/favicon-main.png)
<a href="https://github.com/rjnemo/rentease">
<img src="assets/icons/favicon-main.png" alt="Logo" width="80" height="80"> <!--toc:start-->
</a>
</div> - [Rentease](#rentease)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Built With](#built-with)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
<!--toc:end-->
Rentease is a property-management application to help landlords to manage your rental Rentease is a property-management application to help landlords to manage your rental
properties efficiently. With Rentease, you can create invoices, generate activity properties efficiently. With Rentease, you can create invoices, generate activity
@ -12,9 +21,12 @@ reports, and sync all the booking platforms you use.
## Features ## Features
- **Invoice Management**: Create and manage invoices for your rental properties with ease. - **Invoice Management**: Create and manage invoices for your rental properties
- **Activity Reports**: Generate detailed reports of rental activities to keep track of your property performance. with ease.
- **Platform Sync**: Sync bookings across multiple platforms to streamline your rental management. - **Activity Reports**: Generate detailed reports of rental activities to keep track
of your property performance.
- **Platform Sync**: Sync bookings across multiple platforms to streamline your rental
management.
[![RentEase Screenshot][product-screenshot]](https://example.com) [![RentEase Screenshot][product-screenshot]](https://example.com)
@ -27,14 +39,14 @@ To get started with Rentease, follow these steps.
You need a version of the Go programming language installed. You can either install You need a version of the Go programming language installed. You can either install
it via your package manager or via [Go's official website](https://go.dev/). it via your package manager or via [Go's official website](https://go.dev/).
You also need a PostgreSQL database. You can install it locally using Homebrew or You also need a PostgreSQL database. You can install it locally using Homebrew or
use a cloud alternative such as Railway, fly.io, _etc._. use a cloud alternative such as Railway, fly.io, _etc._
### Installation ### Installation
1. Clone the repository 1. Clone the repository
```sh ```sh
git clone https://github.com/yourusername/rentease.git git clone https://github.com/rjNemo/rentease.git
cd rentease cd rentease
``` ```
@ -54,7 +66,7 @@ use a cloud alternative such as Railway, fly.io, _etc._.
4. **Configure the application**: 4. **Configure the application**:
Create a `.env` file in the project root with the following environment variables: Create a `.env` file in the project root with the following environment variables:
```env ```sh
DB_HOST=localhost DB_HOST=localhost
DB_PORT=5432 DB_PORT=5432
DB_USER=your_db_username DB_USER=your_db_username
@ -75,11 +87,14 @@ use a cloud alternative such as Railway, fly.io, _etc._.
Rentease is built using the following technologies: Rentease is built using the following technologies:
- [Go](https://go.dev/): The core application logic is written in Go, providing a robust and efficient backend. - [Go](https://go.dev/): The core application logic is written in Go, providing a
- [Htmx](https://htmx.org/): For handling AJAX requests and enhancing the user interface with minimal JavaScript. robust and efficient backend.
- [Htmx](https://htmx.org/): For handling AJAX requests and enhancing the user interface
with minimal JavaScript.
- [Templ](https://templ.guide/): Used for templating and rendering dynamic HTML content. - [Templ](https://templ.guide/): Used for templating and rendering dynamic HTML content.
- [Gorm](https://gorm.io/docs): An ORM library for Go, used for database interactions. - [Gorm](https://gorm.io/docs): An ORM library for Go, used for database interactions.
- [PostgreSQL](https://www.postgresql.org/):The database used to store all application data. - [PostgreSQL](https://www.postgresql.org/):The database used to store all application
data.
## Roadmap ## Roadmap