Tenantee

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

Requirements

• Node (LTS)
• Elixir

Running the application

Backend

1. Go to the backend directory
2. Run mix deps.get
3. Run mix phx.swagger.generate (Optional, but Swagger won't work without it)
4. Configure the database in config/dev.exs (or prod.exs if running in prod mode)
5. Run mix ecto.create
6. Run mix ecto.migrate
7. Run mix phx.server (You can run in production mode by appending MIX_ENV=prod before the command)

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

You should have Swagger UI on http://localhost:4000/api

Deploying to production? Please make sure to set all the necessary environment variables and see https://hexdocs.pm/phoenix/deployment.html

Frontend

1. Go to the frontend directory
2. Run npm install
3. Run npm run build

Your static build should be in the dist directory.

You can either run npm run preview or host it via Apache, Nginx or something similar.

Docker

Running the application via Docker is simple and easy.

1. Run docker-compose up -d

Your backend should be running on http://localhost:4000 and the frontend should be available on http://localhost

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 💻

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

Sponsoring