Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 2.7 KB

README.md

File metadata and controls

89 lines (65 loc) · 2.7 KB
icon

 

preview

Demo

Fullstack Linktri Clone

This project is a fullstack clone of Linktree built with Next.js, Tailwind CSS, and MongoDB. It allows users to create a personalized page with links to their content across the internet, customize their profile, and view analytics on their links.

Table of Contents

Features

  • Authentication: Secure login and registration system.
  • Hero Form Registration: Enhanced registration form with real-time validation.
  • User Panel: A dashboard for users to customize their profile, manage links, and view analytics.
    • Sidebar: Easy navigation within the user panel.
    • Basic Profile Info: Users can update their basic information like name, bio, and profile picture.
    • Buttons: Customizable buttons for social media and other links.
    • Links: Users can add, edit, and organize links that appear on their public page.
  • Public Page: A personalized public page for each user, showcasing their profile info, links, and buttons.
  • Analytics: Insights on how many clicks each link receives.
  • Deployment: Guide on deploying the project to production.

Technology Stack

  • Frontend: Next.js, Tailwind CSS
  • Backend: Next.js API Routes
  • Database: MongoDB
  • Authentication: NextAuth
  • Deployment: Vercel, MongoDB Atlas

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Node.js
  • MongoDB

Installation

  1. Clone the repo 
    git clone https://github.com/jeffjiang13/Linktree.git
  2. Install NPM packages 
    npm install
  3. Create a .env.local file and add your MongoDB URI and NextAuth URL 
    MONGO_URI=your_mongodb_uri
NEXTAUTH_URL=http://localhost:3000
  4. Run the development server 
    npm run dev

Project Structure

  • pages/api: Backend logic and API routes.
  • pages: Frontend pages and components.
  • components: Reusable UI components.
  • models: Mongoose models for MongoDB.
  • styles: Global styles and Tailwind configuration.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.