Skip to content

TreeBio is a modern Linktree alternative that lets users showcase all their important links in one customizable page.

License

Notifications You must be signed in to change notification settings

RajdeepKushwaha5/TreeBio1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

44 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌳 TreeBio

TreeBio Logo

A Modern Bio Link Platform for the Digital Age

Live Demo Next.js TypeScript Tailwind CSS License

πŸ“– Description

TreeBio is a powerful, modern bio link platform that transforms the way you showcase your digital presence. Create stunning, customizable profile pages with unlimited links, real-time analytics, QR codes, URL shortening, and advanced customization optionsβ€”all in one seamless platform designed for content creators, entrepreneurs, and businesses.

�️ Tech Stack

  • Frontend: Next.js 15.5.2, React, TypeScript, Tailwind CSS
  • Backend: Next.js API Routes, Prisma ORM
  • Database: PostgreSQL (Neon)
  • Authentication: Clerk
  • Deployment: Vercel
  • Real-time: Pusher
  • UI Components: Radix UI, Lucide React

✨ Features

  • πŸ”— Smart Link Management: Unlimited links with categories, scheduling, and custom icons
  • πŸ“Š Real-time Analytics: Comprehensive tracking with geographic insights and device analytics
  • 🎨 Advanced Customization: Professional themes, custom colors, and mobile-first design
  • πŸ› οΈ Professional Tools: Built-in URL shortener, QR code generator, and bulk import/export
  • πŸ” Secure Authentication: User management with privacy controls and GDPR compliance

πŸš€ Installation

Prerequisites

  • Node.js 18.0 or higher
  • PostgreSQL database
  • Git

Steps

  1. Clone the repository

    git clone https://github.com/RajdeepKushwaha5/TreeBio1.git
    cd TreeBio1
  2. Install dependencies

    npm install
  3. Set up environment variables

    Create a .env.local file in the root directory:

    # Database
    DATABASE_URL="postgresql://username:password@localhost:5432/treebio"
    
    # Clerk Authentication
    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="your_clerk_publishable_key"
    CLERK_SECRET_KEY="your_clerk_secret_key"
    NEXT_PUBLIC_CLERK_SIGN_IN_URL="/sign-in"
    NEXT_PUBLIC_CLERK_SIGN_UP_URL="/sign-up"
    
    # App Configuration
    NEXT_PUBLIC_APP_URL="http://localhost:3000"
    NEXT_PUBLIC_APP_NAME="TreeBio"
    
    # Pusher (Real-time features)
    NEXT_PUBLIC_PUSHER_APP_KEY="your_pusher_key"
    PUSHER_APP_ID="your_app_id"
    PUSHER_SECRET="your_secret"
    NEXT_PUBLIC_PUSHER_CLUSTER="your_cluster"
  4. Set up the database

    npx prisma generate
    npx prisma db push
  5. Start the development server

    npm run dev
  6. Open your browser

    Visit http://localhost:3000 to see TreeBio running locally.

🎯 Usage

  1. Create Account: Sign up using the authentication system
  2. Setup Profile: Add your avatar, bio, and personal information
  3. Add Links: Create and organize your important links
  4. Customize: Choose themes and customize your page design
  5. Share: Share your TreeBio profile URL with your audience
  6. Monitor: Track performance with built-in analytics

Example Profile URL

https://treebio1.vercel.app/yourusername

βš™οΈ Configuration

Environment Variables

Variable Description Required
DATABASE_URL PostgreSQL connection string Yes
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY Clerk publishable key Yes
CLERK_SECRET_KEY Clerk secret key Yes
NEXT_PUBLIC_APP_URL Your app's URL Yes
NEXT_PUBLIC_PUSHER_APP_KEY Pusher app key Optional

Database Setup

TreeBio uses Prisma as the ORM. The database schema includes:

  • Users and authentication
  • Links and collections
  • Analytics and tracking
  • URL shortener data

πŸ”Œ API Documentation

TreeBio provides RESTful API endpoints for all major functionality:

Core Endpoints

  • GET /api/health - Health check
  • GET /api/profile - Get user profile
  • POST /api/links - Create new link
  • GET /api/analytics - Get analytics data
  • POST /api/shortener - Create short URL

Debug Endpoints

  • GET /api/debug/database - Database connection test
  • GET /api/debug/env - Environment variables check

For complete API documentation, run the application locally and visit the debug endpoints.

πŸš€ Deployment

Deploy to Vercel (Recommended)

  1. Fork this repository to your GitHub account

  2. Import to Vercel

  3. Set Environment Variables

    • Add all variables from your .env.local file
    • Set DATABASE_URL to your production database
    • Configure Clerk with production keys
  4. Deploy

    • Click "Deploy"
    • Your TreeBio instance will be live in minutes

Other Platforms

TreeBio can also be deployed to:

  • Railway
  • Heroku
  • DigitalOcean App Platform
  • AWS Amplify

🀝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

Guidelines

  • Follow the existing code style
  • Add tests for new features
  • Update documentation as needed
  • Use conventional commit messages

Reporting Issues

  • Use GitHub Issues to report bugs
  • Include steps to reproduce
  • Specify your environment details

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2025 Rajdeep Kushwaha

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

πŸ™ Acknowledgments

  • Next.js Team for the amazing React framework
  • Vercel for seamless deployment platform
  • Clerk for authentication services
  • Prisma for the excellent ORM
  • Tailwind CSS for the utility-first CSS framework

πŸ‘¨β€πŸ’» Author

Rajdeep Kushwaha

Rajdeep Kushwaha

Full-Stack Developer & Open Source Enthusiast

GitHub X LinkedIn Medium


🌟 If this project helped you, please consider giving it a star!

Live Demo

Made with ❀️ by Rajdeep Kushwaha

About

TreeBio is a modern Linktree alternative that lets users showcase all their important links in one customizable page.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published