https://github.com/sztheory/real-world-phoenix
Real World Phoenix apps and their open source codebases for developers to learn from
https://github.com/sztheory/real-world-phoenix
beam elixir examples phoenix plug real-world real-world-phoenix
Last synced: about 2 months ago
JSON representation
Real World Phoenix apps and their open source codebases for developers to learn from
- Host: GitHub
- URL: https://github.com/sztheory/real-world-phoenix
- Owner: szTheory
- Created: 2020-11-21T15:23:04.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T14:33:09.000Z (over 1 year ago)
- Last Synced: 2025-08-17T00:45:21.490Z (about 2 months ago)
- Topics: beam, elixir, examples, phoenix, plug, real-world, real-world-phoenix
- Homepage:
- Size: 25.4 KB
- Stars: 161
- Watchers: 7
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Real World Phoenix
> Real World Phoenix apps and their open source codebases for developers to learn from
Learn from Phoenix apps written by experienced developers.
You'll find the source code for the Real World Phoenix apps in the [`apps/`](apps/) subdirectory.
Thank you to every developer who has worked on a project this repo links to, your work is helping developers learn Phoenix.
## Additional Requirements
- [git-lfs](https://git-lfs.github.com/)
## How to install on your computer
NOTE: Don't open this repo in trusted mode in VS Code or the Elixir LS extension will use up all of your CPU trying to analyze all of the code.
```bash
# Clone this git repo:
git clone git@github.com:szTheory/real-world-phoenix.git
cd real-world-phoenix/
# The apps are linked to as git submodules.
# This will take some time... (see comment below for possible speedup)
# We add `GIT_LFS_SKIP_SMUDGE=1` to prevent downloading lfs files which are not required and can use a repo's Github quota for bandwidth
GIT_LFS_SKIP_SMUDGE=1 git submodule update --init
# OR if you've got git 2.9+ installed try to run updates in parallel:
# GIT_LFS_SKIP_SMUDGE=1 git submodule update --init --jobs 4
```
## Information for Contributors
### How to add a Real World App
Given a GitHub repo for an app `githubuser/foo`:
```bash
# Inside the project root:
git submodule add -b master git@github.com:githubuser/foo.git apps/foo
```
### Updating the apps submodules to latest
The apps in `apps/` are git submodules. Git submodules are locked to a revision and don't stay in sync with the latest revision.
To update the revisions, run:
```bash
# This will take some time:
git submodule foreach git pull origin master
```
## Other Real World Codebase Collections
- [Real World Erlang Apps](https://github.com/szTheory/real-world-erlang-apps)
- [Real World Elixir Apps](https://github.com/szTheory/real-world-elixir-apps)
- [Real World Plug](https://github.com/szTheory/real-world-plug)
- [Real World Absinthe](https://github.com/szTheory/real-world-absinthe)
- [Real World Nerves](https://github.com/szTheory/real-world-nerves)
- [Real World Rails](https://github.com/eliotsykes/real-world-rails)
- [Real World Sinatra](https://github.com/jeromedalbert/real-world-sinatra)
- [Real World Ruby Apps](https://github.com/jeromedalbert/real-world-ruby-apps)
- [Real World React](https://github.com/jeromedalbert/real-world-react)
- [Real World Ember](https://github.com/eliotsykes/real-world-ember)
- [Real World Django](https://github.com/ckrybus/real-world-django)
- Know any others? Please open a PR and add the link here
---
## Contributors
- Contributions are welcome, fork the GitHub repo, make your changes, then submit your pull request! Reach out if you'd like some help.