mahsu / HTHS-Secret-Santa

Organize gift exchanges and invoke the holiday spirit - exclusively built for High Tech

HTHS-Secret-Santa

HTHS Secret Santa is a convenient and fully integrated gift exchange web application designed to facilitate the coordination of gift exchanges during the holiday season.

###Features:

• Support for custom groups and event groups.
• Automatic random gift exchange partner assignments.
• Fully automated multiyear event support.
• Integrated admin panel with the ability to manage default groups, initiate random partner assignment, and manage event settings.

###Setup Instructions:

1. Make sure you have Composer installed, and install all php dependencies by running:

    composer install
   

2. Make sure you have npm installed, and install all dependencies by running:

    npm install
   

3. Make sure you have grunt-cli installed, and compile all coffeescript and less dependencies by running:

    grunt
   

4. Create the database specified by the schema in database.sql.

5. In /application/config:

   • Duplicate config.template.php and rename it config.php. On line 227, modify

       $config['encryption_key'] = ''; 
     

   to a include secure password of your choosing.

   • Duplicate database.template.php and rename it database.php. Modify your database credentials:

       $db['default']['hostname'] = 'localhost';
       $db['default']['username'] = 'your_username';
       $db['default']['password'] = 'your_password';
       $db['default']['database'] = 'your_database';
     

   • Duplicate oauth.template.php and rename it oauth.php. Modify your google oauth client settings:

       $config['google_client_id'] = 'YOUR_CLIENT_ID';
       $config['google_client_secret'] = 'YOUR_CLIENT_SECRET';
       $config['google_redirect_uri'] = 'YOUR_REDIRECT_URI';
     

   • Duplicate email.template.php and rename it email.php. Change parameters as needed. You can leave this file as-is if you do not wish to use email functionality.

6. In a web browser, visit http://localhost/setup and follow the onscreen instructions to begin basic application setup.

7. If you are deploying the app for a production server, open /index.php. On line 21, change:

    define('ENVIRONMENT', 'development');
   

   to this:

    define('ENVIRONMENT', 'production');
   

###About: A gift from the Class of 2014 ("The Greatest Class of All Time") made possible with contributions from:

• Matthew Hsu (@mahsu)
• Zachary Liu (@zacharyliu)
• Vincent Chen (@vincentschen)