j-sm-n/census

An identity management platform in Rails.

Census - An Identity Manager

Census serves as a central location for identity management and authentication across the Turing School community.

Table of Contents

• Requirements
  • Ruby on Rails
  • Environment Variables
  • Paperclip gem
• Installation
• API Endpoints
• Maintainer
  • Original Contributors
• Contribute
• License

Requirements

Ruby on Rails

RAILS VERSION
  - 5.0.0.1

RUBY VERSION
  - 2.3.0p0

BUNDLED WITH
  - 1.13.7

Environment Variables

Census is built to expect a certain number of environment variables. We suggest using something like Figaro to set them securely.

You will need an AWS S3 Bucket, Access Key ID, a Secret Access Key and an AWS region defined. Use the AWS SDK gem to get started.

Environment Variables:

SALT # used for salting email invite tokens
MY_EMAIL # used for testing purposes. Can be any email.
S3_BUCKET_NAME
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_REGION

Paperclip Gem

Census uses the Paperclip gem in order to upload user profile photos. To ensure testing and development works, ImageMagick must be installed and Paperclip must have access to it.

If you're on Mac OS X, you'll want to run the following with Homebrew:

brew install imagemagick

Installation

To install, clone down the project and run the following commands:

bundle install
bundle exec rake db:{create,migrate}

To run development locally, use the command:

rails server

API Endpoints

To receive a user by name:

GET 'https://login.turing.io/api/v1/users/by_name?q=[NAME]'

Maintainer

• Jeff Casimir - jcasimir

Original Contributors

• Jesse Spevack - PlanetEfficacy
• Calaway - calaway
• Bryan Goss - bcgoss
• Jasmin Hudacsek - j-sm-n

Contribute

TODO: Add a CONTRIBUTING.md

License

TODO: Add a license.md