More Premium Hugo Themes Premium Nextjs Themes

Roadmap

Build and deploy a roadmap voting app for your project/product.

Roadmap

Build and deploy a roadmap voting app for your project/product.

Author Avatar Theme by upstash
Github Stars Github Stars: 181
Last Commit Last Commit: Feb 21, 2024 -
First Commit Created: Aug 27, 2024 -
default image

Overview:

The Roadmap Voting App is a community project where users can deploy the application themselves and allow their users to vote on roadmap features. Users can sign up to add new features, vote on features, configure themselves as admins to set feature requests for release, and delete feature requests. There is an option for an authentication-free version as well.

Features:

  • User Authentication: Users can sign up to add new features and vote on existing ones.
  • Admin Capabilities: Admins can set feature requests for release and delete any feature requests.
  • GitHub OAuth Integration: Uses GitHub for authentication purposes.
  • Deployment to Vercel: Allows easy deployment of the project to Vercel.
  • User Voting System: Users can vote on roadmap features to prioritize them.

Installation:

  1. Set up project:
    mkdir roadmap
    cd roadmap
    npm install
    npm start
    
  2. Configuring Environment Variables: Copy the .env.local.example file to .env.local.
  3. Set up Upstash Redis: Create a new database in the Upstash Console and find the UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.
  4. Setting up user authentication with next-auth: Configure GitHub OAuth for authentication.
  5. Run Your Project: Navigate to the project folder and run npm start.
  6. Making yourself admin: Set the NEXT_PUBLIC_ADMIN_EMAILS environment variable with your GitHub email.
  7. Deploy to Vercel: Create a new GitHub repository, push changes, and deploy to Vercel.

Summary:

The Roadmap Voting App is a community-driven project that enables users to easily set up a platform for roadmap feature voting. With features like user authentication, admin capabilities, GitHub OAuth integration, and Vercel deployment, the app provides a comprehensive solution for managing and prioritizing feature requests.