{"id":13507899,"url":"https://github.com/gothinkster/elixir-phoenix-realworld-example-app","last_synced_at":"2025-03-30T09:33:13.491Z","repository":{"id":26897752,"uuid":"110875205","full_name":"gothinkster/elixir-phoenix-realworld-example-app","owner":"gothinkster","description":"Exemplary real world application built with Elixir + Phoenix","archived":true,"fork":false,"pushed_at":"2022-08-05T07:58:27.000Z","size":293,"stargazers_count":892,"open_issues_count":14,"forks_count":140,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-11-01T07:33:24.416Z","etag":null,"topics":["backend","elixir","elixir-apps","elixir-examples","elixir-lang","elixir-phoenix","phoenix-application","phoenix-framework","realworld"],"latest_commit_sha":null,"homepage":"https://realworld.io","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gothinkster.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-15T19:11:13.000Z","updated_at":"2024-10-28T14:19:42.000Z","dependencies_parsed_at":"2022-08-07T12:01:16.252Z","dependency_job_id":null,"html_url":"https://github.com/gothinkster/elixir-phoenix-realworld-example-app","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gothinkster%2Felixir-phoenix-realworld-example-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gothinkster%2Felixir-phoenix-realworld-example-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gothinkster%2Felixir-phoenix-realworld-example-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gothinkster%2Felixir-phoenix-realworld-example-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gothinkster","download_url":"https://codeload.github.com/gothinkster/elixir-phoenix-realworld-example-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246301963,"owners_count":20755512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","elixir","elixir-apps","elixir-examples","elixir-lang","elixir-phoenix","phoenix-application","phoenix-framework","realworld"],"created_at":"2024-08-01T02:00:42.379Z","updated_at":"2025-03-30T09:33:13.165Z","avatar_url":"https://github.com/gothinkster.png","language":"Elixir","funding_links":[],"categories":["Examples and funny stuff","Elixir"],"sub_categories":[],"readme":"# ![RealWorld Example App](logo.png)\n\u003e 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.  \n\n[![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)\n\nThis codebase was created to demonstrate a fully fledged backend application built with **Elixir and Phoenix** including CRUD operations, authentication, routing, pagination, and more.\n\nWe've gone to great lengths to adhere to the **[credo](https://github.com/rrrene/credo)** community styleguides \u0026 best practices.\n\nFor more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.\n\n## Installing / Getting started\n\nTo run this project, you will need to install the following dependencies on your system:\n\n* [Elixir](https://elixir-lang.org/install.html)\n* [Phoenix](https://hexdocs.pm/phoenix/installation.html)\n* [PostgreSQL](https://www.postgresql.org/download/macosx/)\n\nTo get started, run the following commands in your project folder:\n\n```shell\ncp config/dev.exs.example config/dev.exs  # creates the project's configuration file\nmix deps.get  # installs the dependencies\nmix ecto.create  # creates the database.\nmix ecto.migrate  # run the database migrations.\nmix phx.server  # run the application.\n```\n\nThis is a backend project, you won't be able to go to localhost:4000 and see an aplication. \n\nIn 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`.\n\n## Tests\n\nTo run the tests for this project, simply run in your terminal:\n\n```shell\nmix test\n```\n\n## Documentation\n\nTo generate the documentation, your can run in your terminal:\n\n```shell\nmix docs\n```\n\nThis will generate a `doc/` directory with a documentation in HTML. To view the documentation, open the `index.html` file in the generated directory.\n\n## Style guide\n\nThis 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.\n\n## Licensing\n\nMIT © Ezinwa Okpoechi\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgothinkster%2Felixir-phoenix-realworld-example-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgothinkster%2Felixir-phoenix-realworld-example-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgothinkster%2Felixir-phoenix-realworld-example-app/lists"}