Makers!
So you know about RedwoodJS and maybe even, you’ve decided to make something with it. That something is not perfect, is not necessarily hype nor cool or trendy, but it is and in some way it hasn’t been done much before. That’s cool! We want to hear about it.
On RedwoodJS.com you will find a page dedicated to all the things made with RedwoodJS and some love: the RedwoodJS Examples page! ( page will be live in Launch Week. Don’t miss it! )
This catalog is ready for your entries and we absolutely welcome them. In the event where you’d be willing to put the extra effort though, you are kindly invited to consider our six best practices, to make a repo stand out:
-
The README would outline the app, the features and functionality — not just how to set up. Images will help promote your content.
-
Clear links in README to preview and demo if available, those are super handy for people who need to figure out fast what your thing is about.
-
The application self-documents. Consider making an about page that highlights what the example demonstrates supanews | About
-
The application points back to the repository. Consider a link or an icon in the footer.
-
Add a social preview Github image. In repository Settings > General, it should be right at the top, just beneath the Repository name. A screenshot of your carefully crafted About page will do great.
-
Make sure to fill the description and tags of your repo:
Is your repo ready? Then let’s get in touch, you can reply to this thread with a link to your application, or create your own topic in the #get-help-and-help-others:show-tell section, with a note that you’d like your contribution to be put out there. Someone will pick up the call
With thanks for your contributions
* Credits to @dthyresson for gathering the practices.