https://github.com/vignesh6236/branchify
Branchify is your go to platform to share ALL your personal links!
https://github.com/vignesh6236/branchify
mongodb mongodb-atlas nextjs postman postman-api reactjs tailwindcss
Last synced: 2 months ago
JSON representation
Branchify is your go to platform to share ALL your personal links!
- Host: GitHub
- URL: https://github.com/vignesh6236/branchify
- Owner: Vignesh6236
- Created: 2024-12-28T07:02:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-30T06:56:00.000Z (over 1 year ago)
- Last Synced: 2025-03-25T11:14:21.550Z (about 1 year ago)
- Topics: mongodb, mongodb-atlas, nextjs, postman, postman-api, reactjs, tailwindcss
- Language: JavaScript
- Homepage: https://vignesh-branchify.vercel.app/
- Size: 757 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Branchify 🌿
**Branchify** is your go-to platform to consolidate all your personal links in one place. Create a custom branch and share your curated links with the world seamlessly. Whether for personal branding, social media, or portfolio, Branchify makes link-sharing simple and stylish.
## Table of Contents
- [Project Description](#project-description-)
- [Features](#features-)
- [Tech Stack](#tech-stack-️)
- [Prerequisites](#prerequisites-)
- [Installation and Usage](#installation-and-usage-)
- [Examples of Usage](#examples-of-usage-)
- [Screenshots](#screenshots-)
- [Deployment](#deployment-)
- [Contributing](#contributing-)
- [Acknowledgments](#acknowledgments-)
## Project Description 📋
Branchify allows users to collect and share all their personal links on a single, visually appealing webpage. It is designed for anyone looking to consolidate their online presence or provide a personalized link-sharing experience.
## Features 🌟
- **Easy Integration:** Add links from various platforms like social media, portfolios, or blogs effortlessly.
- **Shareable URL:** Share your Branchify page via a custom URL.
## Tech Stack 🛠️
- **[React](https://reactjs.org/):** For building the user interface.
- **[Next.js](https://nextjs.org/):** For server-side rendering and optimized performance.
- **[Tailwind CSS](https://tailwindcss.com/):** For modern and responsive styling.
- **[MongoDB](https://www.mongodb.com/):** For robust and scalable database management.
- **[Postman](https://www.postman.com/):** For testing and managing APIs.
## Prerequisites 📦
Before getting started, make sure you have the following installed:
- **[Node.js](https://nodejs.org/):** To run the application.
- **[Git](https://git-scm.com/):** For version control.
- **[MongoDB](https://www.mongodb.com/):** To store link data.
- **[Postman](https://www.postman.com/):** (Optional) To test API endpoints.
## Installation and Usage 🚀
Follow these steps to set up Branchify locally:
1. **Clone the Repository:**
```bash
git clone https://github.com/Vignesh6236/Branchify.git
```
2. **Navigate to the Project Directory:**
```bash
cd Branchify
```
3. **Install Dependencies:**
```bash
npm install
```
4. **Set Up Environment Variables:**
Create a `.env.local` file in the root directory with the following variables:
```env
MONGODB_URI=mongodb://localhost:27017
NEXT_PUBLIC_HOST=http://localhost:3000
```
5. **Start the Development Server:**
```bash
npm run dev
```
6. **Open the Application:**
Access the app at [http://localhost:3000](http://localhost:3000).
7. **Create Your Branch:**
Enter your data (e.g., links, handle, description) on the platform. Once you've entered all your details, click Create Branch, then visit your unique URL:
For example, if your handle is `vignesh`, go to:
**[http://localhost:3000/vignesh](http://localhost:3000/vignesh)**
Or for the deployed version, visit:
**[https://vignesh-branchify.vercel.app/vignesh](https://vignesh-branchify.vercel.app/vignesh)**
## Examples of Usage 📖
- **Personal Branding:** Use Branchify to showcase your portfolio, blogs, and social media profiles.
- **Social Media Links:** Consolidate all your profiles into a single, shareable link.
- **Project Links:** Share links to GitHub repositories, live demos, or documentation.
## Screenshots 📷
## Desktop-
https://vignesh-branchify.vercel.app/
https://vignesh-branchify.vercel.app/generate
https://vignesh-branchify.vercel.app/vignesh
## Mobile-
https://vignesh-branchify.vercel.app/
https://vignesh-branchify.vercel.app/generate
https://vignesh-branchify.vercel.app/vignesh
## Deployment 🚀
Branchify is deployed using **[Vercel](https://vercel.com/)** for seamless hosting and quick deployment. You can access the live site here:
**[https://vignesh-branchify.vercel.app/](https://vignesh-branchify.vercel.app/)**
## Contributing 🤝
Contributions are welcome! If you have any ideas or improvements, feel free to submit a [Pull Request](https://github.com/Vignesh6236/Branchify/pulls).
## Acknowledgments 🙏
- **[React](https://reactjs.org/):** For the robust framework.
- **[Next.js](https://nextjs.org/):** For the seamless development experience.
- **[Tailwind CSS](https://tailwindcss.com/):** For the modern styling capabilities.
- **[MongoDB](https://www.mongodb.com/):** For the scalable database solutions.
- **[Postman](https://www.postman.com/):** For API testing and documentation.
- **[Vercel](https://vercel.com/):** For providing seamless deployment and hosting solutions.
---