Skip to content

DockYard/courier_web

Repository files navigation

CourierWeb

Web Adapter, Endpoint, and Client application for Courier.

Build Status

How to use:

In your environment's config you'll need to set the CourierWeber's adapter to Courier.Adapter.Web

config :my_app, MyApp.CourierWeber,
  adapter: Courier.Adapters.Web

Now in your router you'll need to mount the endpoint:

# for a regular Plug Router
forward "/courier_web", to: Courier.Web.Endpoint

# for a Phoenix Router
forward "/courier_web", Courier.Web.Endpoint

The path of /courier_web is just a suggestion, you can mount the application at any path.

Finally when you are ready simply point your browser to the mount point and you'll see the client app!

Authors

We are very thankful for the many contributors

Versioning

This library follows Semantic Versioning

Looking for help with your Elixir project?

At DockYard we are ready to help you build your next Elixir project. We have a unique expertise in Elixir and Phoenix development that is unmatched. Get in touch!

At DockYard we love Elixir! You can read our Elixir blog posts or come visit us at The Boston Elixir Meetup that we organize.

Want to help?

Please do! We are always looking to improve this library. Please see our Contribution Guidelines on how to properly submit issues and pull requests.

Legal

DockYard, Inc. © 2016

@dockyard

Licensed under the MIT license