Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brainbarett/yerin
🏡 Real Estate CMS for agencies to manage their property listings.
https://github.com/brainbarett/yerin
cms javascript laravel php real-estate real-estate-management tdd tdd-laravel tdd-php typescript typescript-vue vue vue2 vuejs vuejs2
Last synced: 2 months ago
JSON representation
🏡 Real Estate CMS for agencies to manage their property listings.
- Host: GitHub
- URL: https://github.com/brainbarett/yerin
- Owner: brainbarett
- License: mit
- Created: 2023-08-05T23:00:38.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-15T02:44:34.000Z (11 months ago)
- Last Synced: 2024-09-27T19:03:05.688Z (3 months ago)
- Topics: cms, javascript, laravel, php, real-estate, real-estate-management, tdd, tdd-laravel, tdd-php, typescript, typescript-vue, vue, vue2, vuejs, vuejs2
- Language: PHP
- Homepage:
- Size: 2.76 MB
- Stars: 15
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yerin
🏡 Real Estate CMS for agencies to manage their property listings. It's currently in its early stages; not production ready.
> 📝 NOTE: Incremental migrations will start when v1.0.0 is released. Until then migration files will be modified.
| Screenshots |
| ------------------------------------------------------------------- |
| 
|
## Table of contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Tests](#tests)
- [Roadmap](#roadmap)
## Requirements
- php >= 8.1
- mysql >= 5.7
- composer (see http://getcomposer.org/download)
## Installation
1. Clone the repo
```
> git clone https://github.com/brainbarett/yerin
```
2. Install the project's dependencies(make sure you're in the project's directory when running the command)
```
> composer install
```
3. Modify the auto-generated `.env` file to reflect your environment(mostly the database credentials)
4. Run the database migrations and seeds
> ⚠️ WARNING: running this command will drop all tables from the specified database
```
> php artisan migrate:fresh --seed --seeder=DemoSeeder
```
5. Run the server
```
> php artisan serve
```
You can log in with email `[email protected]` and password `password`
## Tests
Update your `phpunit.xml` file and set the `DB_DATABASE` value to your testing database
You can then run all the tests with
```
> vendor\bin\phpunit
```
## Roadmap
- v1.0.0
- ✅ Account management
- ✅ Create and modify accounts
- ✅ Authentication
- ✅ Manage and assign roles & permissions
- ✅ Property management
- ✅ Create and modify properties
- ✅ Manage and assign property amenities
- ✅ Images
- ✅ Geographical locations
- ✅ UI translations
- ⬜️ Live demo
- Backlog
- ⬜️ Account management
- ⬜️ Manage and assign tasks
- ⬜️ Property management
- ⬜️ Manage and use dynamic property types
- Manage and use dynamic property fields
- ⬜️ Manage and schedule tours
- ⬜️ Make use of the tasks system
- ⬜️ Manage and add notes
- ⬜️ Manage and upload attachments