├── launchpad_app_banner.png ├── marketplace-app-banner.png └── README.md /launchpad_app_banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/adding-apps-to-redis-marketplace/master/launchpad_app_banner.png -------------------------------------------------------------------------------- /marketplace-app-banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/adding-apps-to-redis-marketplace/master/marketplace-app-banner.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## How to add your projects to the Redis Launchpad 4 | 1. Modify and add the following `marketplace.json` file to your repository's root. 5 | 2. Open an issue on this project asking for us to fork it. 6 | 3. Make sure the "hidden" flag is `true`. We'll switch it to `false` after we review it and fork it. 7 | 4. Your app will be live automatically. 8 | 9 | 10 | ### marketplace.json 11 | Modify the following `marketplace.json`. The details for each property are provided in comments. Fields that are optional: `quick_deploy`, `deploy_button` 12 | ``` 13 | { 14 | "app_name": "", //Name of the app 15 | "description": "", // One line description 16 | "hidden": "", // Can be "true" or "false". If true, this app won't show up in Launchpad. 17 | "rank": "", // This is used to sort the apps in the launchpad. 1 to 20 are reserved. Enter greater than 20 18 | "type": "", //Can be "Building Block" or "Full App" 19 | "contributed_by": "", // Can be "Redis Labs" or "Community" or "Partner" 20 | "repo_url": "", //This is the Gitub Repo's URL. 21 | "download_url": "",//This is a direct link to the Github's download button so people can download it directly from the Marketplace 22 | "hosted_url": "", //The URL of the app. if you are hosting this app somewhere 23 | "quick_deploy": "", //"true" if the project has Heroku, Vercel, Google deploy buttons 24 | "deploy_buttons": [],//Deploy buttons for "heroku", "vercel" or "Google" in the form of objects. 25 | "language": [], // Backend technologies: "JavaScript", "Java", "Python", "Go", "C#", "Ruby", "PHP", etc. 26 | "redis_commands": [], // Enter all the Redis commands 27 | "redis_features": ["caching"],// Enter any core Redis feature or leave it blank. 28 | "redis_modules": [], //Value can be one or more of "RediJSON", "", "RedisTimeseries", "RedisAI" "RedisGears" or "RedisGraph" listed in an array. 29 | "app_image_urls": [ 30 | ], // Provide any image urls in an array. 31 | "youtube_url": "", //Provide a Youtube link to your app's video 32 | "special_tags": [], // "Hackathon", "Paid", or any event names. 33 | "verticals": [], // Can be: "Healthcare", "Financial", "Tourism", "Retail", "Oil & Gas", "Manufacturing", "Technology","Education", "Construction" 34 | "markdown": "" // Link to the RAW Markdown. 35 | } 36 | ``` 37 | 38 | ### Example: 39 | ``` 40 | { 41 | "app_name": "Basic Redis caching example in Nodejs", //Name of the app 42 | "description": "Showcases how to impliment caching in NodeJS", // One line description 43 | "hidden": false, // Can be "true" or "false". If true, this app won't show up in Launchpad. 44 | "rank": 20, // This is used to sort the apps in the marketplace. 1 to 20 are reserved. Enter greater than 20 45 | "type": "Building Block", //Can be "Building Block" or "Full App" 46 | "contributed_by": "Redis Labs", // Can be "Redis Labs" or "Community" or "Partner" 47 | "repo_url": "https://github.com/redis-developer/basic-caching-demo-nodejs", //This is the Gitub Repo's URL. 48 | "download_url": "https://github.com/redis-developer/basic-caching-demo-nodejs/archive/main.zip", 49 | "hosted_url": "", //The URL of the app. if you are hosting this app somewhere 50 | "quick_deploy": "true", //"true" if the project has Heroku, Vercel, Google deploy buttons 51 | "deploy_buttons": [ 52 | { 53 | "heroku": "https://heroku.com/deploy?template=https://github.com/redis-developer/basic-caching-demo-nodejs" //Deploy button URL for deploying on Heroku 54 | }, 55 | { 56 | "vercel": "https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fredis-developer%2Fbasic-caching-demo-nodejs&env=REDIS_ENDPOINT_URI,REDIS_PASSWORD&envDescription=REDIS_ENDPOINT_URI%20is%20required%20at%20least%20to%20connect%20to%20Redis%20clouding%20server" //Deploy button URL for deploying on Vercel 57 | }, 58 | { 59 | "Google": "https://deploy.cloud.run/?git_repo=https://github.com/redis-developer/basic-caching-demo-nodejs.git" //Deploy button URL for deploying on Google cloud. 60 | } 61 | ], 62 | "language": ["JavaScript"], // Backend technologies: "JavaScript", "Java", "Python", "Go", "C#", "Ruby", "PHP", etc. 63 | "redis_commands": ["SETEX"], // Enter all the Redis commands 64 | "redis_features": ["caching"],// Enter any core Redis feature or leave it blank. 65 | "redis_modules": [], //Value can be one or more of "RediJSON", "RediSearch", "RedisTimeseries", "RedisAI" "RedisGears" or "RedisGraph" listed in an array. 66 | "app_image_urls": [ 67 | "https://github.com/redis-developer/basic-caching-demo-nodejs/blob/main/docs/screenshot001.png?raw=true" 68 | ], // Provide any image urls in an array. 69 | "youtube_url": "", //Provide a Youtube link to your app's video 70 | "special_tags": [], // "Hackathon", "Paid", or any event names. 71 | "verticals": ["Healthcare", "Financial"], // Can be: "Healthcare", "Financial", "Tourism", "Retail", "Oil & Gas", "Manufacturing", "Technology","Education", "Construction" 72 | "markdown": "https://raw.githubusercontent.com/redislabs-training/redis-sitesearch/master/README.md" // Link to the RAW Markdown. 73 | } 74 | ``` 75 | 76 | ### Other examples: 77 | 1. [Example Leaderboard app](https://github.com/redis-developer/basic-redis-leaderboard-demo-nodejs/blob/master/marketplace.json) 78 | 79 | 2. [Bitmaps analytics app](https://github.com/redis-developer/basic-analytics-dashboard-redis-bitmaps-nodejs/blob/main/marketplace.json) 80 | 81 | 3. [All these apps have a marketplace.json](https://github.com/redis-developer?q=basic&type=&language=&sort=) 82 | --------------------------------------------------------------------------------