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

Demo    RealWorld

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

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

How it works

Surface is a server-side rendering component library that allows developers to build rich interactive user-interfaces, writing minimal custom Javascript.

Built on top of Phoenix LiveView and its new LiveComponent, Surface leverages the amazing Phoenix Framework to provide a fast and productive solution to build modern web applications.

Installing / Getting started

To run this project, you will need to install the following dependencies on your system:

• Elixir
• Phoenix

To get started, run the following commands in your project folder.

Clone the repository:

git clone https://github.com/razuf/elixir-phoenix-surface-realworld.git
cd elixir-phoenix-surface-realworld/

Install the dependencies:

mix deps.get

Build and run a local development server:

mix phx.server

Open in your browser

This is a frontend project, you can go to http://localhost:4000 and see this aplication.

This is connected to the standard Conduit backend https://conduit.productionready.io/api.

In order to connect other Conduit backends you can download and setup one of the backend projects and set it up as api for this app. Typically this can be done by finding the localhost url and port e.g. localhost:9000 and then put it into:

http://localhost:4000/backend_api_url

Tests

It's on my list to improve.

Documentation

Needs to be done...

Licensing

MIT © Ralph Zühlsdorf