Skip to content

kumail-ahmad/Palm-Link

Repository files navigation

🌴 Palm Tree

Welcome to Palm Tree, a platform that allows users to consolidate and share their online presence seamlessly. With Palm Tree, users can create a visually appealing and customizable landing page to organize and showcase their most important links.

🚀 Features

  • User Profiles: Create personalized profiles with a unique username.
  • Customizable Links: Add, edit, and reorder your links effortlessly.
  • Responsive Design: Optimized for all devices, ensuring accessibility and usability everywhere.
  • Themes and Styling: Choose from various themes or customize your design to reflect your personality.
  • Analytics: Gain insights into link performance with click tracking and engagement stats.
  • SEO Optimization: Enhance discoverability with SEO-friendly pages.
  • Social Media Integration: Seamlessly integrate and showcase your social media accounts.

🛠️ Technologies Used

  • Frontend:
    • React
    • Tailwind CSS
    • Next.js
  • Backend:
    • Node.js
    • Express.js
  • Database:
    • MongoDB
  • Authentication:
    • NextAuth or Firebase Authentication
  • Deployment:
    • Vercel or Netlify for the frontend
    • Render or AWS for the backend

📂 Folder Structure

PalmTree/
├── public/           # Static assets
├── src/
│   ├── components/   # Reusable components
│   ├── pages/        # Routes and main pages
│   ├── styles/       # Styling files
│   ├── utils/        # Helper functions
├── .env              # Environment variables
├── README.md         # Project documentation
└── package.json      # Project dependencies

🔧 Installation

  1. Clone the Repository

    git clone https://github.com/kumail-ahmad/Palm-Link
    cd project-repo
  2. Install Dependencies

    npm install
  3. Set Environment Variables
    Create a .env file in the root directory and include:

    DATABASE_URL=your_database_url
    NEXTAUTH_SECRET=your_secret_key
    NEXT_PUBLIC_BASE_URL=your_base_url
  4. Start the Development Server

    npm run dev
  5. Build for Production

    npm run build
    npm start

🤝 Contribution

Contributions are welcome! Feel free to open issues or submit pull requests to improve this project.

📄 License

This project is licensed under the MIT License.


Releases

No releases published

Packages

No packages published