coderberg/residence-cms

Open Source Property Management System built with Symfony

v2.11.1 2024-10-22 09:33 UTC

Requires

• php: ^8.2
• ext-ctype: *
• ext-gd: *
• doctrine/annotations: ^2.0
• doctrine/doctrine-bundle: ^2.12
• doctrine/doctrine-migrations-bundle: ^3.3
• doctrine/orm: ^2.19
• endroid/qr-code: ^4.8
• gregwar/image: dev-master
• knplabs/knp-paginator-bundle: ^6.4
• phpdocumentor/reflection-docblock: ^5.4
• scheb/2fa-bundle: ^7.5
• scheb/2fa-google-authenticator: ^7.5
• symfony/asset: ^7.1
• symfony/cache: ^7.1
• symfony/console: ^7.1
• symfony/dotenv: ^7.1
• symfony/expression-language: ^7.1
• symfony/flex: ^2
• symfony/form: ^7.1
• symfony/framework-bundle: ^7.1
• symfony/google-mailer: ^7.1
• symfony/http-client: ^7.1
• symfony/intl: ^7.1
• symfony/lock: ^7.1
• symfony/mailer: ^7.1
• symfony/messenger: ^7.1
• symfony/monolog-bridge: ^7.1
• symfony/monolog-bundle: ^3.10
• symfony/notifier: ^7.1
• symfony/process: ^7.1
• symfony/property-access: ^7.1
• symfony/property-info: ^7.1
• symfony/proxy-manager-bridge: ^6.4
• symfony/rate-limiter: ^7.1
• symfony/runtime: ^7.1
• symfony/security-bundle: ^7.1
• symfony/serializer: ^7.1
• symfony/string: ^7.1
• symfony/translation: ^7.1
• symfony/twig-bundle: ^7.1
• symfony/validator: ^7.1
• symfony/web-link: ^7.1
• symfony/webpack-encore-bundle: ^2.1
• symfony/yaml: ^7.1
• symfonycasts/verify-email-bundle: ^1.17
• twig/extra-bundle: ^3.10
• twig/intl-extra: ^3.10
• twig/string-extra: ^3.10
• twig/twig: ^v3.10
• voku/portable-ascii: ^1.6

Requires (Dev)

• coderberg/google-authenticator: ^1.2
• dbrekelmans/bdi: ^1.3
• doctrine/doctrine-fixtures-bundle: ^3.6
• friendsofphp/php-cs-fixer: ^3.59
• phpunit/phpunit: ^9.6
• rector/rector: ^1.2
• symfony/browser-kit: ^7.1
• symfony/css-selector: ^7.1
• symfony/debug-bundle: ^7.1
• symfony/maker-bundle: ^1.60
• symfony/panther: ^2.1
• symfony/phpunit-bridge: ^7.1
• symfony/stopwatch: ^7.1
• symfony/web-profiler-bundle: ^7.1

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-php72: *
• symfony/polyfill-php73: *
• symfony/polyfill-php74: *
• symfony/polyfill-php80: *
• symfony/polyfill-php81: *
• symfony/polyfill-php82: *

MIT

README

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

Requirements

• PHP 8.2.0 or higher;
• PDO PHP Extension;
• GD PHP extension
• MySQL >= 5.7;
• And the usual Symfony application 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 .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
   

6. Run

   $ php bin/console app:install
   

7. Go to http://mywebsite.loc/en/admin and log in.

   login: admin
   password: admin
   

8. 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. Install the ChromeDriver:

   vendor/bin/bdi detect drivers
   

3. Execute this command to run tests:

   php bin/phpunit
   

Additional documentation

• How to run Residence CMS in Docker Containers