IDE>> census>> 返回
项目作者： calaway

项目描述 ：
Census serves as a central location for identity management and authentication across the Turing School community.
高级语言： Ruby
项目地址: git://github.com/calaway/census.git
创建时间： 2017-01-23T18:23:24Z
项目社区：https://github.com/calaway/census
开源协议：
下载


Census - An Identity Manager

security
Code Climate
Build Status

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

Table of Contents

Requirements

Ruby on Rails

  1. RAILS VERSION
  2.   - 5.0.0.1
  4. RUBY VERSION
  5.   - 2.3.0p0
  7. BUNDLED WITH
  8.   - 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:

  1. SALT # used for salting email invite tokens
  2. MY_EMAIL # used for testing purposes. Can be any email.
  3. S3_BUCKET_NAME
  4. AWS_ACCESS_KEY_ID
  5. AWS_SECRET_ACCESS_KEY
  6. 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:

  1. bundle install
  2. bundle exec rake db:{create,migrate}

To run development locally, use the command:

  1. rails server

API Endpoints

To receive a user by name:

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

Maintainer

Original Contributors

Contribute

TODO: Add a CONTRIBUTING.md

License

TODO: Add a license.md