Developer Quick Start

Requirements

• PHP 8.1 or above
• NodeJS 10 or above
• Composer 1.9 or above

Optional Configuration

• A Campaign Monitor API Key and List ID for the Email Service Integration
• A USPS username/password for Postal Address Verification
• A Twilio API token and phone number to send and receive SMS messages and receive voicemail recordings.
• A Geocod.io API token to improve the geocoding of mailing addresses.
• If your server does not support sending outbound emails, SMTP credentials for a server that does (consider using a service like Mandrill, Sendgrid or Mailgun)

Instructions

1. Clone this repository to a project directory
2. Copy .env to .env.local and update the relevant credentials for the database, SMTP server and connected APIs
3. Run composer install to install PHP resources
4. Run npm install to install Javascript resources
5. Run npm run-script build to build WebPack assets (use npm run-script watch to monitor for changes)
6. Run bin/console doctrine:database:create to create database (if necessary)
7. Run bin/console doctrine:migrations:migrate to install database schema
8. Run bin/console app:user:add <email> to create your first admin user
9. Run symfony server:start to launch the web server
10. Visit http://localhost:8000 and use your credentials to log in