README.md

Tenantee

Tenantee (pronounced "tenant-e") is a free and open-source management software aimed at landlords.

Requirements

• Elixir
• PostgreSQL
• Valkey

Running the application

1. Run mix deps.get
2. Configure the database in config/dev.exs (or prod.exs if running in prod mode)
3. Run mix ecto.create
4. Run mix ecto.migrate
5. Run mix phx.server (You can run in production mode by appending MIX_ENV=prod before the command)

Your app should be running on http://localhost:4000

Docker Compose

Running the application via Docker Compose is simple and easy.

1. Run docker-compose up db -d
2. Run docker-compose up valkey -d
3. Run docker-compose build
4. Run docker-compose up app -d

Your app should be running on https://localhost

Docker (without Compose)

Running the application without Docker Compose requires a bit more config. For ease-of-use, create a build.sh file and paste:

#!/bin/bash

export SECRET_KEY_BASE=$(tr -dc A-Za-z0-9 </dev/urandom | head -c 64 ; echo '')
export DATABASE_URL=<ecto connection string>
export VALKEY_URL=<valkey connection string>
export PHX_HOST=localhost

docker build -t tenantee-app . \
    --build-arg SECRET_KEY_BASE=$SECRET_KEY_BASE \
    --build-arg DATABASE_URL=$DATABASE_URL \
    --build-arg VALKEY_URL=$VALKEY_URL

docker run -d \
    --env SECRET_KEY_BASE=$SECRET_KEY_BASE \
    --env DATABASE_URL=$DATABASE_URL \
    --env PHX_HOST=$PHX_HOST \
    --env VALKEY_URL=$VALKEY_URL \
    -p 443:443 \
    tenantee-app

echo $SECRET_KEY_BASE

Then run:

1. chmod +x build.sh
2. ./build.sh

Your app should be running on https://localhost

Production

Deploying to production? Take a look at the guides here.

Not satisfied? Take a look: https://hexdocs.pm/phoenix/deployment.html

Contributing

If you wish to contribute to the project, please refer to the contributing guide first.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Zvonimir Rudinski 🤔 📖 📆 ⚠️ 💻 🚇	Andrej Kovačić 💻	jvince 💻	Luka Evetovic 💻 🚇 📖 🐛	Milly 🐛 💻	MITHIN DEV 📖	Szarvák Ákos 💻
mrahmatu 💻	Steve Shema N. 💻	Rubanfaisal 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Sponsoring