Guidelines for Uploading Recipes + Features to Razroo
Why Build on Razroo + Best Practices Too
Background
You have joined Razroo as a Community Architect, which allows you to contribute to Razroo community paths such as AWS or NextJs.
Alternatively, you would like to upload Razroo Recipes into the Razroo system to upload to the Razroo Marketplace.
You are wondering, how does this Razroo system work? Also, why even use it in the first place?
Why Use Razroo — Why Not Just Build + Sell on Github, Gitlab or Bitbucket?
Razroo was specifically built as a Human Collective Intelligence tool. This means it excels at uploading data (in this scenario code) seamlessly and allowing others to integrate automatically.
Some of the Unique Features Of Razroo
Code Integration Pre-Defined + Seamless For User
This includes the correct version of npm packages, where files should go, as well as automatic integration of code. When you build with Razroo the user integrating your code doesn’t have to do any heavy lifting.
Code + Documentation Packaged Based On Feature
Because Razroo code is packaged based on a feature, it allows for Razroo code to be easily commented on and perused. As opposed to opening an issue, can zero in the code itself.
Razroo’s Code Recommendation Engine
Because Razroo’s code is feature-based and not repository-based, Razroo can offer recommendations to users generating your code. This makes it so that there is a seamless process when users are integrating your code.
Razroo will always point them to the right direction. In addition, users will suggest your code to others to potentially use/purchase.
Razroo Code Generation Tooling (Github + VSCode)
All code built on Razroo is immediately accessible to users via Github and VSCode. If I am a user and I want to integrate this code with my github codebase, I can simply integrate using Razroo’s VSCode Plugin or Github Portal.
Razroo Building Blocks
Once again Razroo is a Human Collective Intelligence platform. The entire platform was built so people can upload and integrate data seamlessly. Tru to this mission Razroo offers you building blocks so you can zero on the feature you want. Instead of having to set up a repo, with 20–30 features everytime, Razroo has that available for you.
Uploading To Razroo — Best Practices
Right now there are two things we do not have within the Razroo system which are on the roadmap:
- The ability to run Node within the browser
- A peer review system
Therefore:
- The code does need to run locally
- Peer Review systems happen via Github
Therefore, the following is our current workflow:
- Code is built feature by feature. This is so commenting, documentation + consumption can be isolated to a particular feature.
- Uploading code to Razroo’s Code CMS is treated as regular developer ticket. A ticket is created and assigned to the user using Razroo’s (AI) Ticketing System.
- One singular unified approach towards building a recipe book. For instance, if the first recipe/starter uses Nrwl Nx, NextJs App Router, and ShadcnUI then all following recipes/features follow this same convention.
- A GitHub repo is created using the starter step of the repo if one does not already exist. Changes are made on a github branch, and pushed through as a pull request
- Once code is merged, it is then uploaded to the respective razroo feature.
These four steps are the current Razroo workflow for creating recipes + features.
All Set!
You are all set and ready to go. Your contribution will contribute towards Human Collective Intelligence that will all of humanity to benefit from the fruits of our labor!