Elixir (Phoenix) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with Elixir and Phoenix including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the credo community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Current Status

• Auth
  • Login
  • Login and remember token
  • Register
  • Current User
  • Update User
• Articles
  • All Articles
  • Articles by Author
  • Articles Favorited by Username
  • Articles by Tag
  • Single Article by Slug
• Articles with Auth
  • Feed
  • All Articles
  • Articles by Author
  • Articles Favorited by Username
  • Create Article
  • Delete Article
  • Update Article
  • Favorite Article
  • Unfavorite Article
• Comments
  • Create Comment for Article
  • All Comments for Article
  • Delete Comment for Article
• Profiles
  • Profile
  • Follow Profile
  • Unfollow Profile
• Tags
  • All tags

Getting started

1. Install phoenix as well as all the other dependencies (erlang, elixir, postgresql).
2. Clone the repo.
3. Run the following commands in the project directory:
   • mix deps.get to install dependencies.
   • cp config/dev.exs.example config/dev.exs and setup with your database credentials.
   • mix ecto.create to create the database.
   • mix ecto.migrate to run the database migrations.
   • mix phx.server to run the application.

License

MIT © Ezinwa Okpoechi