A retreat management application written in Laravel based in part on CiviCRM
We will be setting up our development environment in Laravel Homestead, a virtual machine provided by Laravel that meets all the system requirements needed for the Laravel framework. This will make setting up for development a breeze 💨.
git clone https://github.com/arborrow/montserrat.git
Must have the following installed:
- Composer
- Node (Node is not required if using Laravel Sail as your virtual environment)
Running the following command will also add Homestead to the current project.
composer install
yarn install
For Laravel Homestead, install:
For Laravel Sail, install:
- Docker: Install Docker in Ubuntu or you can follow the Digital Ocean instructions
- docker-compose
- Read more about using Laravel Sail
If not creating inside of vagrant, you may need to create your .env file by copying .env.example to .env and providing the database configuration settings (host, name, username and password).
Following commands must be executed inside your vagrant box.
cd codephp artisan migrate:fresh --seed
Run the following command to generate an application key
php artisan key:generate
Output
Application key [...] set successfully.
Copy the text inside the [] and uncomment APP_KEY={app_key} in your .env file. Replace {app_key} with the copied text.
Navigate to Google Cloud Console and login in with your preferred Google account.
- Create a new project
- Navigate to
APIs & Service - Once in
APIs & Service, navigate toLibrary - Search for
Google People APIand select it (Socialite previously used Google+ API; however, Google+ API was suspended in 2019) - Enable the API and create a new OAuth client ID.
- Set your redirect URI depending on your development environment. For Sail,
http://localhost/login/google/callback. For Vagrant/Homestead,http://localhost:8000/login/google/callback
Navigate to Twilio and login/signup.
- Navigate to your console.
- Navigate to your dashboard where you will see
ACCOUNT SIDandAUTH TOKEN. - Navigate to Phone Numbers and under Active Numbers create a new number.
Uncomment the following lines in your .env file
GOOGLE_CLIENT_ID={google_client_id}
GOOGLE_CLIENT_SECRET={google_client_secret}
TWILIO_SID={twilio_sid}
TWILIO_TOKEN={twilio_token}
For Google People API replace {google_client_id} with your client ID and {google_client_secret} with your client secret.
For Twilio replace {twilio_sid} with your ACCOUNT SID, {twilio_token} with your AUTH TOKEN, and {twilio_number} with your Twilio phone number. (Do not add dashes and parentheses.)
Once you have done everything above navigate to localhost:8000 (Laravel Homestead) or localhost (Laravel Sail) . Once you login using Google Auth, your user will not have any role assigned to it. Hence you will not be able to do anything. You must do this before trying to get superuser access
After installing composer dependencies, run npm install and npm run production to build frontend assets including FullCalendar.
Run the following command to assign yourself (given that you are the first user to login) as the superuser.
php artisan db:seed --class=RoleUserTableSeeder
The command above will assign the very first user as the superuser. The command will fail if no user exists.
You're all set!
Prior to committing code changes, it is suggested to run the phpunit tests. Test development remains a work in progress. The test environment requires extensive setup and makes use of a fresh MySQL database. The initial database migration and seeding helps to ensure that things are setup to run well. It is recommended that you copy the .env.example file and set it up to use a testing database. Then migrate and seed the database.
- php artisan --env=testing migrate:fresh --seed
- php artisan --env=testing db:seed --class=TestPermissionRolesSeeder
When creating a retreat the ID number is generated automatically. The next value is determined by incrementing the highest numeric portion of existing retreat IDs. The generated number is shown on the creation form and cannot be edited.
Polanco supports multiple interface languages.
The following locale codes are included:
en– Englishes– Spanishpt– Portuguese
Edit your .env file and set APP_LOCALE to one of the supported codes:
APP_LOCALE=es
php artisan config:clearThe config:clear command reloads the configuration so the new default takes effect.
A Language dropdown is available in the top navigation bar. Choose a language from this menu to update the interface instantly. The selected locale is stored in your session and will be used for subsequent pages.
Polanco includes a monthly room schedule available at /rooms. This page renders a matrix of rooms versus days and highlights reserved or occupied dates. Reserved or occupied cells display the retreatant's name and link directly to the reservation. Reservations can be dragged between rooms to update assignments. You can view other months by appending a date in YYYYMMDD format to the URL. For example, /rooms/20250101 shows January 2025.
The schedule logic is implemented in RoomController::schedule.
Usage notes:
- Drag a reservation cell to another room to move a retreatant.
- Click a name to open the reservation record.
Polanco provides an event calendar at /calendar powered by FullCalendar. The calendar displays retreats from the database and allows easy browsing of upcoming events.