mirror of
https://github.com/rjNemo/rentease.git
synced 2026-06-06 02:36:49 +00:00
124 lines
3.4 KiB
Markdown
124 lines
3.4 KiB
Markdown
<a name="readme-top"></a>
|
|
|
|
<br />
|
|
<div align="center">
|
|
<a href="https://github.com/rjnemo/rentease">
|
|
<img src="assets/icons/favicon-main.png" alt="Logo" width="80" height="80">
|
|
</a>
|
|
|
|
<h1 align="center">RentEase</h1>
|
|
|
|
<p align="center">
|
|
Property management application for landlords of short-time rental properties.
|
|
<br />
|
|
<br />
|
|
<a href="https://rentease-production-269d.up.railway.app/">Production deployment</a>
|
|
</p>
|
|
</div>
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#about-the-project">About The Project</a>
|
|
<ul>
|
|
<li><a href="#built-with">Built With</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#getting-started">Getting Started</a>
|
|
<ul>
|
|
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
<li><a href="#installation">Installation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#usage">Usage</a></li>
|
|
<li><a href="#roadmap">Roadmap</a></li>
|
|
<li><a href="#contributing">Contributing</a></li>
|
|
<li><a href="#license">License</a></li>
|
|
<li><a href="#contact">Contact</a></li>
|
|
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
|
|
## About The Project
|
|
|
|
[![RentEase Screen Shot][product-screenshot]](https://example.com)
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
### Built With
|
|
|
|
- [Go](https://go.dev/)
|
|
- [Htmx](https://htmx.org/)
|
|
- [Templ](https://templ.guide/)
|
|
- [PostgreSQL](https://www.postgresql.org/)
|
|
- [Railway](https://railway.app/)
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
## Getting Started
|
|
|
|
This is an example of how you may give instructions on setting up your project locally.
|
|
To get a local copy up and running follow these simple example 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](https://go.dev/).
|
|
You also need a PostgreSQL database. You can install it locally using Homebrew or use a cloud alternative such as
|
|
Railway.
|
|
|
|
### Installation
|
|
|
|
1. Clone the repo
|
|
```sh
|
|
git clone https://github.com/rjnemo/rentease.git
|
|
```
|
|
2. Install
|
|
```sh
|
|
go mod download
|
|
```
|
|
3. Start the development server
|
|
```sh
|
|
make dev
|
|
```
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
## Roadmap
|
|
|
|
See the [open issues](https://github.com/users/rjNemo/projects/2/views/1) for a full list of proposed features (and
|
|
known issues).
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- CONTRIBUTING -->
|
|
|
|
## 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!
|
|
|
|
1. Fork the Project
|
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
|
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
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- LICENSE -->
|
|
|
|
## License
|
|
|
|
Distributed under the MIT License. See `LICENSE.md` for more information.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|