Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rowyio/roadmap
Roadmap voting app for sharing product plan and get customer feedback.
https://github.com/rowyio/roadmap
cloud-functions firebase lowcode remix remix-run roadmap starter-template vercel
Last synced: 15 days ago
JSON representation
Roadmap voting app for sharing product plan and get customer feedback.
- Host: GitHub
- URL: https://github.com/rowyio/roadmap
- Owner: rowyio
- License: apache-2.0
- Created: 2022-12-21T02:51:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-17T21:05:44.000Z (9 months ago)
- Last Synced: 2024-08-01T16:55:42.824Z (3 months ago)
- Topics: cloud-functions, firebase, lowcode, remix, remix-run, roadmap, starter-template, vercel
- Language: TypeScript
- Homepage: https://roadmap.rowy.io
- Size: 384 KB
- Stars: 237
- Watchers: 9
- Forks: 45
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - rowyio/roadmap - Roadmap voting app for sharing product plan and get customer feedback. (TypeScript)
README
Get users' feedback and votes for your product roadmap
Join a community of Low-code / No-code builders, devs and makers
[](https://discord.gg/fjBugmvzZP)
Live Demo .
One-click Deploy ·
Powered by Rowy
## Overview
Open-source product roadmap app that can be shared publicly with your users to collect valuable feedback. Users can upvote/downvote on features, add comments, request for new features. Keep your users in the loop with workflows notifying them when a feature is ready. The app’s frontend is built with Remix and the backend is built with [Rowy](https://www.rowy.io?utm_source=github&utm_campaign=readme&utm_medium=roadmap) (a lowcode platform for Firebase).
## Demo
Explore a [live demo](https://roadmap.rowy.io/) of the roadmap app
## Features
- [x] Get feedback on your roadmap from public user groups or communities
- [x] Upvote and downvote
- [x] Comments
- [x] Customizable categories: In progress, Next, Needs feedback, Release ..
- [x] Open-source, flexible and fully free
- [x] Optionally, comes with an in-app feedback widget for open ended feeature requests or feeback
- [x] CMS UI with ability to add any automation or workflows with Rowy
## Setup Guide
Full setup instructions video available [here](https://roadmap.vote/setupvideo)
### Step 1: Setup backend template
The backend for the roadmap app is setup on Firebase and managed via Rowy which is a lowcode platform for Firebase. Rowy gives you a Table UI to manage your the data for your roadmap app along with getting all the backend cloud functions for managing the roadmap app setup in one click.
_Don't worry if you are not familiar with Firebase, Rowy will guide you through the entire process._
1. Create an account on [Rowy](https://www.rowy.io?utm_source=github&utm_campaign=readme&utm_medium=roadmap) and create a workspace for the Roadmap app
2. Create a new project by connecting it to Firebase - step by step video
3. Create a new table from "Roadmap app" template
4. Now you can manage your app’s data on Rowy’s CMS for Firestore. Add the initial set of data to be displayed on the roadmap app i.e. your product’s features list, their description, target release date, category etc.
### Step 2: Setup frontend template
Deploy the roadmap app’s frontend to Vercel using the deploy button. Add the following environment variables. Instructions on how to configure them are available on the GitHub repo.
#### One click deploy to Vercel 👇
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frowyio%2Froadmap&env=CLIENT_FIREBASE_WEB_API_KEY,SERVER_FIREBASE_SERVICE_ACCOUNT,SESSION_SECRET,COLLECTION,TABLE_ID&project-name=rowy-roadmap&repository-name=rowy-roadmap)
#### Add the following environment variables to your app on Vercel
- `CLIENT_FIREBASE_WEB_API_KEY` – Add your Firebase project's web API key. Get it from your Firebase project [here](https://console.firebase.google.com/u/0/project/_/settings/general)
- `SERVER_FIREBASE_SERVICE_ACCOUNT` – Generate a Firebase admin sdk service account JSON and add that to your config by following this [link](https://console.firebase.google.com/u/0/project/_/settings/serviceaccounts/adminsdk) to your Firebase project
- `COLLECTION` – Name of the Firestore collection that stores the roadmap data. Default to `roadmap`
- `TABLE_ID` – Name of the Rowy Table ID. Default to `roadmap`
- `SESSION_SECRET` – `Optional` setup a session secret
- `FEEDBACK_FIN_WEBHOOK_URL` – `Optional` If you want to add a feedback widget to your roadmap app, add the webhook URL setup using [FeedbackFin](https://github.com/rowyio/feedbackfin)
### Step 3: That's it 🎉
Vercel gives you a hosted app domain or [create customized URL](https://vercel.com/docs/concepts/projects/domains/add-a-domain). Make sure to add this domain URL to list of [authorized domains](https://console.firebase.google.com/u/0/project/_/authentication/settings) in your Firebase project. Now you are all set to share this URL with your users and start gathering votes/feedback on your product roadmap.
## Contribution and development guide
If you would like to contribute to this project, then follow this development setup guide.
To run your app locally, make sure your project's local dependencies are installed.
```
npm install
```
Then, start the app's development server.
```
npm run dev
```
Open your roadmap app on http://localhost:3000
