Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gothinkster/elixir-phoenix-realworld-example-app

Exemplary real world application built with Elixir + Phoenix
https://github.com/gothinkster/elixir-phoenix-realworld-example-app

backend elixir elixir-apps elixir-examples elixir-lang elixir-phoenix phoenix-application phoenix-framework realworld

Last synced: 3 months ago
JSON representation

Exemplary real world application built with Elixir + Phoenix

Host: GitHub
URL: https://github.com/gothinkster/elixir-phoenix-realworld-example-app
Owner: gothinkster
License: mit
Archived: true
Created: 2017-11-15T19:11:13.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2022-08-05T07:58:27.000Z (over 2 years ago)
Last Synced: 2024-08-02T02:11:45.290Z (6 months ago)
Topics: backend, elixir, elixir-apps, elixir-examples, elixir-lang, elixir-phoenix, phoenix-application, phoenix-framework, realworld
Language: Elixir
Homepage: https://realworld.io
Size: 286 KB
Stars: 889
Watchers: 23
Forks: 137
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

freaking_awesome_elixir - Elixir - Elixir / Phoenix implementation of [RealWorld.io](https://realworld.io/) backend specs - a Medium clone. (Examples and funny stuff)
fucking-awesome-elixir - real world example app - Elixir / Phoenix implementation of [RealWorld.io](https://realworld.io/) backend specs - a Medium clone. (Examples and funny stuff)
awesome-elixir - real world example app - Elixir / Phoenix implementation of [RealWorld.io](https://realworld.io/) backend specs - a Medium clone. (Examples and funny stuff)

README

# ![RealWorld Example App](logo.png)
> Elixir (Phoenix) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld-example-apps) spec and API.

[![CircleCI](https://circleci.com/gh/gothinkster/elixir-phoenix-realworld-example-app.svg?style=svg)](https://circleci.com/gh/gothinkster/elixir-phoenix-realworld-example-app) [![codecov](https://codecov.io/gh/gothinkster/elixir-phoenix-realworld-example-app/branch/master/graph/badge.svg)](https://codecov.io/gh/gothinkster/elixir-phoenix-realworld-example-app)

This codebase was created to demonstrate a fully fledged backend 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](https://github.com/rrrene/credo)** 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.

## Installing / Getting started

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

* [Elixir](https://elixir-lang.org/install.html)
* [Phoenix](https://hexdocs.pm/phoenix/installation.html)
* [PostgreSQL](https://www.postgresql.org/download/macosx/)

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

```shell
cp config/dev.exs.example config/dev.exs # creates the project's configuration file
mix deps.get # installs the dependencies
mix ecto.create # creates the database.
mix ecto.migrate # run the database migrations.
mix phx.server # run the application.
```

This is a backend project, you won't be able to go to localhost:4000 and see an aplication.

In order to see the [Conduit](https://demo.realworld.io/#/) frontend you will need to download and setup one of the [frontend projects](https://demo.realworld.io/#/) and set it up to consume this apps api. Typically this can be done by finding the `API_URL` and setting it to `localhost:4000`.

## Tests

To run the tests for this project, simply run in your terminal:

```shell
mix test
```

## Documentation

To generate the documentation, your can run in your terminal:

```shell
mix docs
```

This will generate a `doc/` directory with a documentation in HTML. To view the documentation, open the `index.html` file in the generated directory.

## Style guide

This project uses [mix format](https://hexdocs.pm/mix/master/Mix.Tasks.Format.html). You can find the configuration file for the formatter in the `.formatter.exs` file.

## Licensing