Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upstash/roadmap
Build and deploy a roadmap voting app for your project/product.
https://github.com/upstash/roadmap
auth0 nextjs redis serverless
Last synced: 5 days ago
JSON representation
Build and deploy a roadmap voting app for your project/product.
- Host: GitHub
- URL: https://github.com/upstash/roadmap
- Owner: upstash
- License: mit
- Created: 2021-04-05T20:58:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T23:15:14.000Z (11 months ago)
- Last Synced: 2025-01-09T00:28:43.507Z (12 days ago)
- Topics: auth0, nextjs, redis, serverless
- Language: TypeScript
- Homepage: https://roadmap.upstash.com
- Size: 3.23 MB
- Stars: 173
- Watchers: 10
- Forks: 29
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Roadmap Voting App
> [!NOTE]
> **This project is a Community Project.**
>
> The project is maintained and supported by the community. Upstash may contribute but does not officially support or assume responsibility for it.
You can deploy Roadmap application yourself and ask your users to vote for your
roadmap features. See the [live example](https://roadmap.upstash.com).
In this version, the user should sign up to add a new feature and vote them up.
Also you can configure yourself as admin, to set a feature request as `release`
also delete any feature request.
If you prefer the one without authentication, see
the [old version](https://github.com/vercel/next.js/tree/canary/examples/with-redis)
.
## Docs
1. [Set up project](#1-set-up-project)
2. [Configuring Environment Variables](#2-configuring-environment-variables)
3. [Set up Database](#3-set-up-upstash-redis)
4. [Set up user authentication with next-auth](#4-set-up-user-authentication-with-next-auth)
5. [Run Your Project](#5-run-your-project)
6. [Let's make ourselves admin](#6-lets-make-ourselves-admin)
7. [Deploy to Vercel](#7-deploy-to-vercel)
## `1` Set up project
First, open up your terminal and navigate and run the following:
```
npx create-next-app --example https://github.com/upstash/roadmap roadmap
```
This will create a new folder in your current directory called **roadmap**.
Then, you can navigate into the folder, install the dependencies, and launch the
app:
```
cd roadmap && npm i
```
## `2` Configuring Environment Variables
Copy the `.env.local.example` file to `.env.local` (which
will be ignored by Git):
```bash
cp .env.local.example .env.local
```
## `3` Set up Upstash Redis
Go to the [Upstash Console](https://console.upstash.com/) and create a new
database
#### Upstash environment
`UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` find the variables in
the database details page in Upstash Console.
## `4` Set up user authentication with next-auth
We will use the **[next-auth](https://next-auth.js.org/)** library for
authentication. This example is preconfigured to use GitHub OAuth.
To set up GitHub for authentication:
1) Go to [GitHub Developer Settings](https://github.com/settings/apps) on
GitHub.
2) Click on **"New GitHub App"**.
3) Name your **"GitHub App name"**
4) Add your **"Homepage URL"** (or a placeholder, if you don't have a website
yet).
5) For the **"Callback URL"** field, put http://localhost:3000.
> Since GitHub only
> allows one callback URL per app, we have to create separate apps for
> localhost and production (hence the "dev" name in step 3).
6) If the active field under "Webhook" is checked, uncheck it. Now, click on **"
Create Github App"**
7) Once your app is created, you should see the following screen. Click on **"
Generate a new client secret"**
8) Copy the client secret you generated and paste it under the `GITHUB_SECRET`
value in your .env file
9) Copy the **Client ID** and paste it under the `GITHUB_ID` value in your .env
file
## `5` Run Your Project
In the project folder, run
```
npm run dev
```
## `6` Let's make ourselves admin
Only admin users can delete and release content.
`NEXT_PUBLIC_ADMIN_EMAILS`: Enter your Github emails here, separated by commas.
## `7` Deploy to Vercel
First, create a new Github repository and push your local changes.
[Deploy it to Vercel](https://vercel.com/docs/concepts/git#deploying-a-git-repository)
. Ensure you add
all [Environment Variables](https://vercel.com/docs/concepts/projects/environment-variables)
in your .env file to Vercel during the import process.