A lightweight URL shortener built with Next.js and deployed on Vercel. Redirect mappings are stored in a single JSON file, making it trivial to maintain.
- The app reads
public/redirects.jsonat build time. - Visiting
your-domain.com/githubredirects to the mapped URL. - Unknown paths return a 404 page.
- The root path
/redirects to thedefaultURL, if configured.
Edit public/redirects.json to manage your redirects. Nested keys are supported for organization:
{
"default": "https://example.com",
"github": "https://github.com/yourname",
"cv": "https://cv.example.com",
"social": {
"linkedin": "https://linkedin.com/in/yourname",
"twitter": "https://twitter.com/yourname"
}
}| Path | Redirects to |
|---|---|
/ |
default value |
/github |
https://github.com/yourname |
/social/linkedin |
https://linkedin.com/in/yourname |
npm install
npm run dev| Command | Description |
|---|---|
npm run dev |
Start development server |
npm run build |
Build for production |
npm test |
Run tests |
npm run typecheck |
TypeScript typecheck |
npm run validate:redirects |
Validate redirects.json against schema |
Connect the repository to a Vercel project via the Vercel dashboard. Vercel automatically deploys on every push to main. The CI workflow runs typecheck and tests on every push and pull request independently.
Vercel Analytics is enabled by default. Visit the Vercel dashboard to view redirect traffic.
Made by Oliwer Pawelski / Guliveer