This is Northstar, the DoSomething.org user & identity API. It's our single "source of truth" for member information. Northstar is built using Laravel 5.2 and MongoDB.
Check out the API Documentation to start using Northstar! ✨
Fork and clone this repository, and install into your local DS Homestead.
After installation, set environment variables, create your public & private keys, and run the outstanding migrations:
$ cp .env.example .env
$ openssl genrsa -out storage/keys/private.key 1024
$ openssl rsa -in storage/keys/private.key -pubout -out storage/keys/public.key
$ php artisan migrate
You can seed the database with test data:
$ php artisan db:seed
You may run unit tests locally using PHPUnit:
$ vendor/bin/phpunit
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.
Consider writing a test case when adding or changing a feature. Most steps you would take when manually testing your code can be automated, which makes it easier for yourself & others to review your code and ensures we don't accidentally break something later on!
We take security very seriously. Any vulnerabilities in Northstar 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.
©2016 DoSomething.org. Northstar 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.