Code Monkey home page Code Monkey logo

tenantee's Introduction

Tenantee

Coverage Status GitHub issues GitHub pull requests GitHub last commit (branch) GitHub

All Contributors

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

Requirements

  • Elixir
  • PostgreSQL
  • Redis

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 redis -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 REDIS_URL=<redis 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 REDIS_URL=$REDIS_URL

docker run -d \
    --env SECRET_KEY_BASE=$SECRET_KEY_BASE \
    --env DATABASE_URL=$DATABASE_URL \
    --env PHX_HOST=$PHX_HOST \
    --env REDIS_URL=$REDIS_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
Zvonimir Rudinski

🤔 📖 📆 ⚠️ 💻 🚇
Andrej Kovačić
Andrej Kovačić

💻
jvince
jvince

💻
Luka Evetovic
Luka Evetovic

💻 🚇 📖 🐛
Milly
Milly

🐛 💻
MITHIN DEV
MITHIN DEV

📖
Szarvák Ákos
Szarvák Ákos

💻

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

Sponsoring

Buy Me a Coffee at ko-fi.com

tenantee's People

Contributors

zvonimirr avatar dependabot[bot] avatar allcontributors[bot] avatar jvince avatar kovay024 avatar lukaevet avatar milafazekas avatar mithindev avatar akosszarvak avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.