This is Chompy, the DoSomething.org importer app. Chompy is built using Laravel 6 and bootstrap-sass.
Check out the documentation for details about Chompy imports. 🐸
To get started with development, you'll first need local instances of Northstar and Rogue setup to use for running Chompy imports on your localhost.
Next, fork and clone this repository, and add it to your Homestead. SSH into your VirtualBox, navigate to your Chompy directory, and run the installation steps:
# Install dependencies
$ composer install && npm install
# Configure application & run migrations:
$ php artisan chompy:setup
# Finally, build the frontend assets:
$ npm run devWhen running php artisan chompy:setup, add your local instances of Northstar and Rogue, along with your local Northstar auth credentials. The step for setting up Pusher is safe to ignore, as it is not required to run imports locally.
We follow Laravel's code style and automatically lint all pull requests with StyleCI. Be sure to configure EditorConfig to ensure you have proper indentation settings.
Performance & debug information is available at /__clockwork, or using the Chrome Extension.
We take security very seriously. Any vulnerabilities in Chompy should be reported to security@dosomething.org, and will be promptly addressed. Thank you for taking the time to responsibly disclose any issues you find.
© DoSomething.org. Chompy is free software, and may be redistributed under the terms specified in the LICENSE file. The name and logo for DoSomething.org are trademarks of Do Something, Inc and may not be used without permission.