Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hassox/phoenix_guardian

A demo application showing usage of guardian and ueberauth
https://github.com/hassox/phoenix_guardian

Last synced: 3 days ago
JSON representation

A demo application showing usage of guardian and ueberauth

Awesome Lists containing this project

README 

        
# PhoenixGuardian



[![Build Status](https://travis-ci.org/hassox/phoenix_guardian.svg?branch=ueberauth-guardian)](https://travis-ci.org/hassox/phoenix_guardian)



Provides an example implementation for authentication in Phoenix applications

using Überauth and Guardian.



The main user model is `User` which has many `Authorization`s. This is done so

that for any given user they can have authorizations from different sources.

Github, Slack, Email/Password etc.



Once we have the user in the system - Guardian steps in to provide request

implementation.



The two systems, Überauth and Guardian, are independent and are used together in

this application for demonstration purposes.



To start your Phoenix app:



  1. Install dependencies with `mix deps.get && npm install`

  2. Create and migrate your database with `mix ecto.create && mix ecto.migrate`

  3. Start Phoenix endpoint with `mix phoenix.server`

  4. Export secrets for your Github and Slack application in your environment

    * ```GITHUB_CLIENT_ID```

    * ```GITHUB_CLIENT_SECRET```

    * ```SLACK_CLIENT_ID```

    * ```SLACK_CLIENT_SECRET```



Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.



To visit the admin site, after you've created a user you should flip the

"is_admin" boolean on the users table in the database.



Then visit [`localhost:4000/admin/users`](http://localhost:4000/admin/users)



## What to look for



The site is broken into two broad parts



1. Normal section - optionally logged in

2. Admin section - requires login of a user who is an admin



## License



Copyright (c) 2015 Daniel Neighman



Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:



The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.