mirror of
https://github.com/rjNemo/rentease.git
synced 2026-06-12 13:46:51 +00:00
This commit is contained in:
parent
23f3ceec21
commit
d75533d431
1 changed files with 105 additions and 99 deletions
200
README.md
200
README.md
|
|
@ -1,143 +1,149 @@
|
||||||
# Rentease
|
# RentEase
|
||||||
|
|
||||||
|
Smart property management for short and mid‑term rentals: ingest bookings from
|
||||||
|
multiple sources, keep owners and guests in sync, and turn payments into clean
|
||||||
|
financial reporting.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!--toc:start-->
|
<!--toc:start-->
|
||||||
|
|
||||||
- [Rentease](#rentease)
|
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Getting Started](#getting-started)
|
- [Visuals](#visuals)
|
||||||
- [Prerequisites](#prerequisites)
|
- [Quick Start](#quick-start)
|
||||||
- [Installation](#installation)
|
- [Configuration](#configuration)
|
||||||
- [Built With](#built-with)
|
- [Usage](#usage)
|
||||||
|
- [Development](#development)
|
||||||
|
- [Tech Stack](#tech-stack)
|
||||||
|
- [Project Layout](#project-layout)
|
||||||
- [Roadmap](#roadmap)
|
- [Roadmap](#roadmap)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
|
- [Support](#support)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
- [Status](#status)
|
||||||
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
|
## Features
|
||||||
|
|
||||||
- **Invoice Management**: Create and manage invoices for your rental properties
|
- **Invoice management**: Create and track invoices for each stay.
|
||||||
with ease.
|
- **Activity reports**: Export booking and payment reports for owners and accountants.
|
||||||
- **Activity Reports**: Generate detailed reports of rental activities to keep track
|
- **Multi-platform sync**: Consolidate bookings from different channels.
|
||||||
of your property performance.
|
- **Stripe automation (optional)**: Pull card payments from Stripe, validate webhooks,
|
||||||
- **Platform Sync**: Sync bookings across multiple platforms to streamline your rental
|
and trigger manual syncs when needed.
|
||||||
management.
|
- **PDF generation**: Produce guest-ready invoices and summaries.
|
||||||
|
|
||||||
|
## Visuals
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Getting Started
|
## Quick Start
|
||||||
|
|
||||||
To get started with Rentease, follow these steps.
|
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
You need a version of the Go programming language installed. You can either install
|
- Go (go.mod targets 1.25.4; use Go 1.22+ in practice)
|
||||||
it via your package manager or via [Go's official website](https://go.dev/).
|
- Docker + Docker Compose (for the recommended dev stack)
|
||||||
You also need a PostgreSQL database. You can install it locally using Homebrew or
|
- PostgreSQL 14+ (Docker Compose starts one automatically)
|
||||||
use a cloud alternative such as Railway, fly.io, _etc._
|
|
||||||
|
|
||||||
### Installation
|
### Run with Docker Compose (recommended)
|
||||||
|
|
||||||
1. Clone the repository
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/rjNemo/rentease.git
|
git clone https://github.com/rjNemo/rentease.git
|
||||||
cd rentease
|
cd rentease
|
||||||
```
|
|
||||||
|
|
||||||
2. Install the dependencies
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go mod download
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Setup PostgreSQL**:
|
|
||||||
Ensure you have PostgreSQL installed and running. Create a database for Rentease:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
createdb rentease
|
|
||||||
```
|
|
||||||
|
|
||||||
4. **Configure the application**:
|
|
||||||
Create a `.env` file in the project root with the following environment variables:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
DB_HOST=localhost
|
|
||||||
DB_PORT=5432
|
|
||||||
DB_USER=your_db_username
|
|
||||||
DB_PASSWORD=your_db_password
|
|
||||||
DB_NAME=rentease
|
|
||||||
# Stripe configuration (optional until you enable automatic sync)
|
|
||||||
APP_STRIPE_SECRET_KEY=sk_test_your_key
|
|
||||||
APP_STRIPE_WEBHOOK_SECRET=whsec_your_webhook_secret
|
|
||||||
APP_STRIPE_ACCOUNT_ID=acct_your_account_id
|
|
||||||
```
|
|
||||||
|
|
||||||
Leave the Stripe variables blank to continue using manual cash entry only. When set, Rentease will pull payments from Stripe, process webhooks sent to `/webhooks/stripe`, and expose a manual sync endpoint at `POST /api/stripe/sync` (protected by the existing API key middleware). Providing `APP_STRIPE_ACCOUNT_ID` also enables dashboard links for synchronized card payments.
|
|
||||||
|
|
||||||
5. Start the application
|
|
||||||
|
|
||||||
```sh
|
|
||||||
make dev
|
make dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### Development Commands
|
This starts the app on `http://localhost:8000` with hot reload and a local
|
||||||
|
Postgres instance.
|
||||||
|
|
||||||
Use the included Makefile for common tasks:
|
### Run locally without Docker
|
||||||
|
|
||||||
- `make dev`: Run the dev container with live reload (Air) on `http://localhost:8000`.
|
```sh
|
||||||
- `make run`: Build and run the production image locally.
|
git clone https://github.com/rjNemo/rentease.git
|
||||||
- `make test`: Run `go test ./...` inside the dev container.
|
cd rentease
|
||||||
- `make format`: Generate templ files and format code.
|
go mod download
|
||||||
- `make lint`: Lint with `golangci-lint`.
|
cp .env.example .env # create this file using the Configuration section below
|
||||||
- `make stop`: Stop the dev container.
|
go run .
|
||||||
|
```
|
||||||
|
|
||||||
6. **Access the application**:
|
Set `APP_PORT` (defaults to 4200) to change the listening port when running locally.
|
||||||
Open your browser and go to `http://localhost:8000` to start using Rentease.
|
|
||||||
|
|
||||||
### Built With
|
## Configuration
|
||||||
|
|
||||||
Rentease is built using the following technologies:
|
Configuration is driven by environment variables (parsed with the `APP_` prefix).
|
||||||
|
Minimum required variables:
|
||||||
|
|
||||||
- [Go](https://go.dev/): The core application logic is written in Go, providing a
|
```sh
|
||||||
robust and efficient backend.
|
APP_DATABASE_URL=postgres://user:pass@localhost:5432/rentease?sslmode=disable
|
||||||
- [Htmx](https://htmx.org/): For handling AJAX requests and enhancing the user interface
|
APP_ADMIN=admin@example.com
|
||||||
with minimal JavaScript.
|
APP_ADMIN_SECRET=choose-a-strong-password
|
||||||
- [Templ](https://templ.guide/): Used for templating and rendering dynamic HTML content.
|
APP_API_KEY=your-api-key
|
||||||
- [Gorm](https://gorm.io/docs): An ORM library for Go, used for database interactions.
|
APP_SECRET_KEY=signing-secret
|
||||||
- [PostgreSQL](https://www.postgresql.org/):The database used to store all application
|
APP_SESSION_SECRET=session-secret
|
||||||
data.
|
APP_ORIGINS=http://localhost:8000
|
||||||
|
# Optional
|
||||||
|
APP_PORT=8000
|
||||||
|
APP_DEBUG=true
|
||||||
|
APP_LOG_LEVEL=debug
|
||||||
|
APP_STRIPE_SECRET_KEY=
|
||||||
|
APP_STRIPE_WEBHOOK_SECRET=
|
||||||
|
APP_SENTRY_DSN=
|
||||||
|
```
|
||||||
|
|
||||||
### Service Layout
|
Stripe values can be left blank for manual payment entry only.
|
||||||
|
When provided, webhooks are received at `/webhooks/stripe` and a manual sync is
|
||||||
|
available at `POST /api/stripe/sync` (API key protected).
|
||||||
|
|
||||||
- `internal/service/booking`: booking lifecycle, items, reporting, and PDF generation.
|
## Usage
|
||||||
- `internal/service/payment`: manual payments plus Stripe synchronisation and webhook handling.
|
|
||||||
|
- Start the stack (`make dev`) and open `http://localhost:8000`.
|
||||||
|
- Default dev credentials (from `docker-compose.dev.yml`):
|
||||||
|
- `admin@example.com` & `supersecret`.
|
||||||
|
- Create bookings, issue invoices, and review payments from the dashboard.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
- `make dev` — run the dev stack with hot reload on `:8000`.
|
||||||
|
- `make test` — run `go test ./...`.
|
||||||
|
- `make format` — generate templ files and format Go + templ sources.
|
||||||
|
- `make lint` — run `golangci-lint`.
|
||||||
|
- `make run` — build and run the production image locally.
|
||||||
|
- `make stop` — shut down the dev stack.
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
- Go backend with PostgreSQL
|
||||||
|
- [Templ](https://templ.guide/) for server-rendered components
|
||||||
|
- [htmx](https://htmx.org/) for dynamic interactions with minimal JavaScript
|
||||||
|
- [GORM](https://gorm.io/) for database access
|
||||||
|
- [Stripe](https://stripe.com/) integration for payment syncing
|
||||||
|
|
||||||
|
## Project Layout
|
||||||
|
|
||||||
|
- `internal/service/booking` — booking lifecycle, items, reporting, PDF generation.
|
||||||
|
- `internal/service/payment` — manual payments plus Stripe sync and webhook handling.
|
||||||
|
- `internal/view` — templ components (generate `_templ.go` files locally).
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
See the [open issues](https://github.com/users/rjNemo/projects/2/views/1) for a full
|
Track planned work and known issues on the [project board](https://github.com/users/rjNemo/projects/2/views/1).
|
||||||
list of proposed features (and known issues).
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are what make the open source community such an amazing place to learn,
|
Issues and pull requests are welcome! To propose a change:
|
||||||
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
|
1. Fork the repository.
|
||||||
a pull request. You can also simply open an issue with the tag "enhancement".
|
2. Create a feature branch (`git checkout -b feature/amazing-idea`).
|
||||||
|
3. Run the test suite and linters (`make test`, `make lint`).
|
||||||
|
4. Open a PR describing your change and any setup notes.
|
||||||
|
|
||||||
Don't forget to give the project a star! Thanks again!
|
## Support
|
||||||
|
|
||||||
1. Fork the Project
|
Need help or found a bug? Please open an issue in this repository with as much
|
||||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
context as possible (logs, steps, and expected behavior).
|
||||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
|
||||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
|
||||||
5. Open a Pull Request
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Distributed under the MIT License. See `LICENSE.md` for more information.
|
Distributed under the MIT License. See `LICENSE.md` for more information.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Active development.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue