Skip to content

Latest commit

 

History

History
143 lines (134 loc) · 8.99 KB

examples.md

File metadata and controls

143 lines (134 loc) · 8.99 KB

Examples

In keeping with the guiding principle to "Minimize Setup Friction," there are some things that may be pretty common for web applications to do, but aren't common enough to be included in the main template.

This page links to examples of how to implement some things with the Epic Stack.

How to contribute

Kent screencast showing the examples page

Watch: Contribute an Epic Stack Example

You don't need permission to contribute an example. Feel free to create your own repository based on the Epic Stack and add whatever you like for your example. Here are some tips:

  1. Create an init commit as soon as you generate the project, before you make any changes. That way people can look at the commit history of your example and see what you've added.
  2. Update the README.md with some information about what your example is about and call out any interesting things you've done.
  3. Add the tags "epic-stack" and "epic-stack-example" so it will appear on this page on GitHub.
  4. It's not normally necessary to deploy your example to production (simply comment out the deployment part of the GitHub workflow), but you can if you like.

Once you've made your repo, simply open a pull request to this page and add your example to the bottom of the list with a brief description.