coderberg/residence-cms

Open Source Property Management System built with Symfony


README

GitHub Build Status

ResidenceCMS is a fast and lightweight Property Management System on top of Symfony 5.

The user interface is built with Bootstrap 4.

GitHub

Requirements

Installation

  1. Install Composer (see http://getcomposer.org/download)

  2. Create new project via Composer

    $ composer create-project coderberg/residence-cms mywebsite.loc
    
  3. Enter the newly created folder

    $ cd mywebsite.loc
    
  4. After installing you should configure your web server's document / web root to be the public directory.

  5. Create an empty MySQL database

  6. Create .env.local from .env file and fill in your database credentials

    DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name
    
  7. Run

    $ php bin/console doctrine:migrations:migrate
    $ php bin/console doctrine:fixtures:load
    
  8. Go to http://mywebsite.loc/admin and log in.

    login: admin
    password: admin
    
  9. To use feedback forms, configure MAILER_DSN in .env.local

Tests

  1. Modify your DATABASE_URL config in .env.test.local

    DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name
    
  2. Execute this command to run tests:

    php bin/phpunit
    

Additional documentation