https://github.com/coderberg/residencecms

Open Source Property Management System based on Symfony 7
https://github.com/coderberg/residencecms

cms php-cms php8 real-estate symfony symfony-application symfony7

Last synced: about 9 hours ago
JSON representation

Open Source Property Management System based on Symfony 7

• Host: GitHub
• URL: https://github.com/coderberg/residencecms
• Owner: Coderberg
• License: mit
• Created: 2018-09-09T20:21:07.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-28T17:59:18.000Z (8 months ago)
• Last Synced: 2024-04-19T12:03:17.252Z (7 months ago)
• Topics: cms, php-cms, php8, real-estate, symfony, symfony-application, symfony7
• Language: PHP
• Homepage:
• Size: 24.9 MB
• Stars: 126
• Watchers: 16
• Forks: 53
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Coderberg/ResidenceCMS/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Coderberg/ResidenceCMS/?branch=master) [![Testing with MySQL](https://github.com/Coderberg/ResidenceCMS/actions/workflows/mysql.yml/badge.svg)](https://github.com/Coderberg/ResidenceCMS/actions/workflows/mysql.yml) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Coderberg_ResidenceCMS&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=Coderberg_ResidenceCMS)

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

![GitHub](https://raw.githubusercontent.com/Coderberg/ResidenceCMS/master/docs/images/screenshot.png)

## Requirements

- PHP 8.2.0 or higher;

- PDO PHP Extension;

- GD PHP extension

- MySQL >= 5.7;

- And the [usual Symfony application requirements][2].

## Installation

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

2. Create new project via [Composer][3]

   ```

   $ 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:[email protected]: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:[email protected]: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][4]

[1]: https://symfony.com/

[2]: https://symfony.com/doc/current/setup.html#technical-requirements

[3]: https://getcomposer.org/doc/03-cli.md#create-project

[4]: https://github.com/Coderberg/ResidenceCMS/blob/master/docs/docker.md