<div align="center">

# `auth_plug`

The Elixir Plug that _seamlessly_ handles
all your authentication/authorization needs.

[![Build Status](](
[![ dependency status](](
<br />

## Why? 🤷

You want a way to add authentication
to your Elixir/Phoenix App
in the fewest steps and least code.
We did too. So we built `auth_plug`.

***Frustrated*** by the **complexity**
and **incomplete docs/tests**
in **_existing_ auth solutions**,
we built **`auth_plug`** to **simplify** our lives. <br />

We needed a way to ***minimise***
the steps
and **code** required
to add auth to our app(s).
**`auth_plug`** allows us to **setup**
auth in any Elixir/Phoenix
App in **_less_ than 2 minutes**
with only **5 lines** of config/code
and **_one_ environment variable**.


<!-- revisit or remove this section
### Pain 😧

We try to maintain a
["beginner's mind"](
in everything we do.

There are virtually infinite options
for 3rd party Authentication.
Most are complex and unfriendly to beginners.
They require understanding the difference
between an authentication scheme, strategy or implementation.
We have used everything from
[black box](
(closed source)
services that promise the world but are consistently
painful to setup, to open source projects that
are woefully undocumented and lack automated tests
so we cannot _rely_ on them.
We got tired of compromising on the UX of auth,
so we built _exactly_ what we wanted
as the "users" of our own product.


## What? 🔐

An Elixir Plug (_HTTP Middleware_)
that a _complete_ beginner can use to add auth to a
Phoenix App
and _understand_ how it works. <br />
No macros/behaviours to `use` (_confuse_).
No complex configuration or "implementation".
Just a basic plug that uses Phoenix Sessions
and standards-based JSON Web Tokens (JWT).
Refreshingly simple. The way auth _should_ be done.

<div align="center">
    <a href="">
        <img src="" alt="auth_plug diagram">

Edit this diagram:

**`auth_plug`** protects any routes in your app
that require authentication. <br />
For more detail on how the `Auth` service works,
please see:

**`auth_plug`** is just
[57 lines](
of (_significant_)
the rest is comprehensive comments
to help _everyone understand_ how it works.
As with _all_ our code,
it's meant to be as beginner-friendly as possible.
If you get stuck or have any questions,
please [***ask***!](

## Who? 👥

We built this plug for use in _our_ products/services.
It does _exactly_ what we want it to and nothing more.
It's tested, documented and open source the way _all_ our code is.
It's **not _yet_** a **general purpose** auth solution
that _anyone_ can use.
If after reading through this you feel that
this is something you would like to have
in your own Elixir/Phoenix project,
let us [***tell us***!](

# How? 💡

## 1. Installation 📝

Add **`auth_plug`**
to your list of dependencies in `mix.exs`:

def deps do
    {:auth_plug, "~> 0.12.0"}
Once you've saved the `mix.exs` file,
download the dependency with:

mix deps.get

## 2. Get Your `AUTH_API_KEY` 🔑

And create your `AUTH_API_KEY`.


### 2.1 Save it as an Environment Variable

Create a file called `.env` in the root directory of your app
and add the following line:

export AUTH_API_KEY=2cfxNaWUwJBq1F4nPndoEHZJ5YCCNqXbJ6GaSXj6BPNTjMSc4EV/2cfxNadrhMZk3iaT1L5k6Wt67c9ScbGNPz8BwLH1qvpDNAARQ9J

The run the following command in your terminal:
source .env
That will export the environment variable AUTH_API_KEY.

Remember to add `.env` to your [`.gitignore`]( file.
echo ".env" >> .gitignore

## 3. _Protect_ a Route

Open your project's `router.ex` file. e.g:

### (Optional) Update `endpoint.ex`

## Documentation

Documentation can be found at
[]( <br />
All our code is commented,
but if _anything_ is unclear,
please open an issue:

## Recommended / Relevant Reading

If you are new to Elixir Plug,
we recommend following:

To understand JSON Web Tokens,