mirror of https://github.com/rjNemo/rentease.git synced 2026-06-06 02:36:49 +00:00

Property management app

Find a file

Ruidy c79232a019 fix linter warning		2024-08-21 22:01:37 +02:00
.github/workflows	up goversion	2024-08-21 17:02:47 +02:00
assets	update css and js	2024-08-10 13:37:42 +02:00
cmd/cron	basic task scheduler	2024-06-30 12:49:26 +02:00
config	use colorful logger	2024-08-21 16:56:11 +02:00
constant	use constants	2024-06-20 18:34:57 +02:00
internal	fix linter warning	2024-08-21 22:01:37 +02:00
pkg/time	use std lib for time formatting	2024-04-12 17:31:24 +02:00
.air.toml	use docker dev env	2024-08-09 15:33:33 +02:00
.gitignore	install G Calendar client	2024-08-03 22:33:50 +02:00
Dockerfile	debug calendar secrets (#15 )	2024-08-09 14:36:14 +02:00
Dockerfile.dev	upgrade to Go 1.23	2024-08-21 07:41:54 +02:00
go.mod	use colorful logger	2024-08-21 16:56:11 +02:00
go.sum	use colorful logger	2024-08-21 16:56:11 +02:00
main.go	improve config setup	2024-08-21 09:49:31 +02:00
Makefile	improve dev dockerfile	2024-08-19 13:59:41 +02:00
README.md	use left join for bookings and items	2024-06-28 17:03:23 +02:00

README.md

Rentease

Rentease is a property-management application to help landlords to manage your rental properties efficiently. With Rentease, you can create invoices, generate activity reports, and sync all the booking platforms you use.

Features

Invoice Management: Create and manage invoices for your rental properties with ease.
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 Screen Shot][product-screenshot]

Getting Started

To get started with Rentease, follow these steps.

Prerequisites

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. You also need a PostgreSQL database. You can install it locally using Homebrew or use a cloud alternative such as Railway.

Installation

Clone the repository

git clone https://github.com/yourusername/rentease.git
cd rentease

Install the dependencies
```
go mod download
```
Setup PostgreSQL: Ensure you have PostgreSQL installed and running. Create a database for Rentease:
```
createdb rentease
```

Configure the application: Create a .env file in the project root with the following environment variables:

DB_HOST=localhost
DB_PORT=5432
DB_USER=your_db_username
DB_PASSWORD=your_db_password
DB_NAME=rentease

Start the application
```
make dev
```
Access the application: Open your browser and go to http://localhost:8000 to start using Rentease.

Built With

Rentease is built using the following technologies:

Go: The core application logic is written in Go, providing a robust and efficient backend.
Htmx: For handling AJAX requests and enhancing the user interface with minimal JavaScript.
Templ: Used for templating and rendering dynamic HTML content.
Gorm: An ORM library for Go, used for database interactions.
PostgreSQL:The database used to store all application data.

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. See LICENSE.md for more information.

TODO

other dates are not stored/parsed properly