Interactive Conversation Archive

Dependencies

• Apache
• PHP ^5.4
• MySQL ^5.5

Development dependencies please check in package.json.

Setting Up

• Install development dependencies: npm install

• Make a copy of app/.htaccess.example as app/.htaccess in the same directory.

  Then replace <http-host> with the local host, e.g. localhost, if the website is hosted on http://localhost/*.

• Make a copy of app/config.oauth2.php.example as app/config.oauth2.php in the same directory.

  Then replace <http-host> with the local host same as above, e.g. localhost, if the website is hosted on http://localhost/*.

  Currently, the login mechanism utilizes OAuth 2 at https://accounts.mintkit.net/. OAUTH2_CLIENT_ID and OAUTH2_CLIENT_SECRET may be updated if necessary. Please contact sethlu@mintkit.net for custom client id and secret.

• Make a copy of app/config.php.example as app/config.php in the same directory.

  Then replace <http-host> with the local host same as above, e.g. localhost, if the website is hosted on http://localhost/*.

  Then replace <mysql-host>, <mysql-database>, <mysql-user> and <mysql-password> with the corresponding database information.

  A database seed is available at db/seed.sql.

• Make a copy of config.json.example as config.json in the same directory.

  Then replace <server-proxy> with the url to the locally hosted website, e.g. http://localhost/, under which is the app/ contents.

• Make a copy of app/config.algolia.php.example as app/config.algolia.php in the same directory.

  Then replace <algolia-app-id>, <algolia-api-key> and <algolia-index> with the corresponding values from Algolia.

• Front-end build: gulp build.

  Or start the front-end build and watch for changes: gulp or gulp proxy.

Notes on Architecture

• Component: A syntactical sugar for the JavaScript class.