WR.DO

Docs
Installation

Installation

How to install the project.

Create project

Start by creating a new Next.js project using create-next-app:

npx create-next-app wrdo --example "https://github.com/oiov/wr.do"

Or deploy with Vercel :

Deploy with Vercel

A good way to create your repository, but the deployment will fail because you need to add your environment variables locally in your project. Follow the documentation for that.

Install dependencies

Enter in the folder and install dependencies for your project:

cd wrdo
pnpm install

Create a .env file

Copy/paste the .env.example in the .env file:

Environment VariableValueDescription
NEXTAUTH_URLhttp://localhost:3000The URL of the Next.js application.
AUTH_SECRET123465The secret used to encrypt tokens and email verification hashes.
DATABASE_URLfile:./db.sqliteThe path to the postgres database.
GOOGLE_CLIENT_ID123465The ID of the Google OAuth client.
GOOGLE_CLIENT_SECRET123465The secret of the Google OAuth client.
GITHUB_ID123465The ID of the GitHub OAuth client.
GITHUB_SECRET123465The secret of the GitHub OAuth client.
RESEND_API_KEY123465The API key for Resend.
CLOUDFLARE_ZONE_ID123465The zone ID for Cloudflare.
CLOUDFLARE_API_KEY123465The API key for Cloudflare.
CLOUDFLARE_EMAIL123465The email for Cloudflare.
NEXT_PUBLIC_FREE_RECORD_QUOTA3The number of free records.
NEXT_PUBLIC_FREE_URL_QUOTA100The number of free URLs.
NEXT_PUBLIC_OPEN_SIGNUP1Open signup.
SCREENSHOTONE_BASE_URLhttps://api.example.compending
GITHUB_TOKENghp_sscsfarwetqethttps://github.com/settings/tokens
  • How to get GOOGLE_CLIENT_ID、GITHUB_ID, see Authentification.
  • How to get RESEND_API_KEY, see Email.
  • How to get CLOUDFLARE_ZONE_ID、CLOUDFLARE_API_KEY、CLOUDFLARE_EMAIL, see Cloudflare Configs.
  • How to get DATABASE_URL, see Database.

Configuration part

Let's check the configuration part for update all environment variables before use pnpm run dev.

Other PlatformsCloudflare