README.md

Github Redirect

About   |   Demo   |   Requirements   |   Starting   |   Author

🎯 About

This project consists of a web server that redirects requests to a GitHub profile or to specific repositories. When the path is "/", it redirects to the GitHub profile. For other paths, it attempts to access information from a repository through the GitHub API. If the repository exists, it redirects to its URL; otherwise, it displays a custom error page.

👀 Demo

https://gh.lauty.dev/

✅ Requirements

• Node.js
• Bun

🏁 Starting

# Clone this project
$ git clone https://github.com/LautyDev/Github-Redirect

# Access
$ cd Github-Redirect

# Install dependencies
$ bun i

# Configure environment variables
$ echo "GITHUB_USER=your_github_username" > .env

# Run the project
$ bun start

# The server will initialize in the <http://localhost:5000>

🐳 Docker

$ docker run -p 5000:5000 -e GITHUB_USER=your_github_username ghcr.io/lautydev/github-redirect:latest

# The server will initialize in the <http://localhost:5000>

Made with ❤️ by LautyDev

 

Back to top