https://github.com/team-alembic/realworld
A fullstack Phoenix LiveView application with backend built with Ash Framework
https://github.com/team-alembic/realworld
ash-framework elixir-lang liveview phoenix-framework
Last synced: 4 months ago
JSON representation
A fullstack Phoenix LiveView application with backend built with Ash Framework
- Host: GitHub
- URL: https://github.com/team-alembic/realworld
- Owner: team-alembic
- License: mit
- Created: 2023-02-06T00:07:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T16:56:53.000Z (about 1 year ago)
- Last Synced: 2025-04-09T22:18:29.654Z (7 months ago)
- Topics: ash-framework, elixir-lang, liveview, phoenix-framework
- Language: Elixir
- Homepage:
- Size: 278 KB
- Stars: 168
- Watchers: 4
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ash-framework - Realworld - A fullstack Phoenix LiveView application with backend built with Ash Framework. (Demo projects / Phoenix LiveView Components)
- awesome-ash-framework - Realworld - A fullstack Phoenix LiveView application with backend built with Ash Framework. (Demo projects / other)
README
# 
> ### Ash + Phoenix LiveView codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.
### [Demo](https://realworld-ash.fly.dev/) [RealWorld](https://github.com/gothinkster/realworld)
This codebase was created to demonstrate a fully fledged fullstack application built with **Ash** + **Phoenix LiveView** including CRUD operations, authentication, routing, pagination, and more.
We've gone to great lengths to adhere to the **Ash** + **Phoenix LiveView** community styleguides & best practices.
For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.
# How it works
> A fullstack phoenix liveview application with backend built with [Ash Framework](https://ash-hq.org/).
### Prerequisites
* erlang 25.2 and elixir 1.14.2-otp-25
* PostgreSQL 14.6
### Installation
1. Clone the repo
```
git clone https://github.com/team-alembic/realworld.git
```
2. Install dependencies
```
cd realworld
mix deps.get
```
3. Create a postgres database and run migration with ash_postgres
```
mix ash.setup && mix ash.migrate
```
### Test
1. Create a test database and run migration with ash_postgres
```
MIX_ENV=test mix ash_postgres.create && MIX_ENV=test mix ash.migrate
```
2. Run the tests
```
mix test
```
# Getting started
To start your Phoenix server:
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
# Sending a Pull Request
The consultants at Alembic are monitoring for pull requests when they are “on the beach” (aka when they are not billable or working with a client). We will review your pull request and either merge it, request changes to it, or close it with an explanation. For changes raised when there are no consultants on the beach, please expect some delay. We will do our best to provide update and feedback throughout the process.