Logo

RentEase

Property management application for landlords of short-time rental properties.

Production deployment

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments
## About The Project [![RentEase Screen Shot][product-screenshot]](https://example.com)

(back to top)

### Built With - [Go](https://go.dev/) - [Htmx](https://htmx.org/) - [Templ](https://templ.guide/) - [PostgreSQL](https://www.postgresql.org/) - [Railway](https://railway.app/)

(back to top)

## 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 ```

(back to top)

## Roadmap See the [open issues](https://github.com/users/rjNemo/projects/2/views/1) for a full list of proposed features (and known issues).

(back to top)

## 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

(back to top)

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

(back to top)