Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.71 KB

README.md

File metadata and controls

74 lines (50 loc) · 2.71 KB
Raw

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/ 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

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.

# 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:

# 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:

# This will take some time:
git submodule foreach git pull origin master

Other Real World Codebase Collections

Contributors

  • Contributions are welcome, fork the GitHub repo, make your changes, then submit your pull request! Reach out if you'd like some help.