Skip to content

Debcharon/microbin-console

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

Configuration

Create a .env.local file in the root directory with the following variables:

# API Configuration
API_BASE_URL=https://api.link.microbin.dev
ADMIN_TOKEN=your-secret-admin-token

# Public Configuration
NEXT_PUBLIC_REDIRECT_BASE_URL=https://link.microbin.dev

# Console Authentication
CONSOLE_PASSWORD=your-console-password

# Site Branding (Server-side - used in page metadata)
SITE_TITLE=Microbin Console
SITE_DESCRIPTION=Create custom path short links with 301 redirects

# Site Branding (Client-side - used in page UI)
NEXT_PUBLIC_SITE_TITLE=Microbin Console
NEXT_PUBLIC_SITE_SUBTITLE=创建自定义路径短链接(301 跳转)
NEXT_PUBLIC_HEADER_LINK_TEXT=link.microbin.dev
NEXT_PUBLIC_HEADER_LINK_HREF=https://link.microbin.dev

Environment Variables

API Configuration:

  • API_BASE_URL: The URL of the Microbin API
  • ADMIN_TOKEN: Your admin token for the API

Public Configuration:

  • NEXT_PUBLIC_REDIRECT_BASE_URL: The base URL for generated short links (e.g., https://link.microbin.dev)

Console Authentication:

  • CONSOLE_PASSWORD: The password required to access the console

Site Branding (Server-side): These variables are used in page metadata (browser tab title, search engine descriptions):

  • SITE_TITLE: Browser tab title (default: "Microbin Console")
  • SITE_DESCRIPTION: Page meta description (default: "Create custom path short links with 301 redirects")

Site Branding (Client-side): These variables customize the UI elements visible on the page:

  • NEXT_PUBLIC_SITE_TITLE: Main page heading/title (default: "Microbin Console")
  • NEXT_PUBLIC_SITE_SUBTITLE: Page subtitle/description (default: "创建自定义路径短链接(301 跳转)")
  • NEXT_PUBLIC_HEADER_LINK_TEXT: Text displayed in the header link (default: "link.microbin.dev")
  • NEXT_PUBLIC_HEADER_LINK_HREF: URL for the header link (default: "https://link.microbin.dev")

Note: All branding variables have sensible defaults, so the console works out-of-the-box without configuration. Set these variables to customize the console for your deployment environment.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You will be redirected to the login page. Enter the password you configured in CONSOLE_PASSWORD to access the console.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

Shorten and Custom path for Links

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •