BioBranch is a streamlined and customizable platform that lets you manage and showcase all your social media handles and important links in one place. Inspired by Linktree, BioBranch offers an easy-to-use interface for creating a personal landing page where you can share your online presence with the world.
- π¨ Customizable Profiles: Personalize your BioBranch page with themes, colors, and styles that perfectly match your brand's vibe.
- π Effortless Link Management: Easily add, remove, or rearrange your links with a user-friendly dashboard designed for smooth updates.
- π Analytics at Your Fingertips: Track clicks and visitor stats in real-time to optimize your online presence and engagement.
- π± Fully Responsive Design: Whether on mobile, tablet, or desktop, your BioBranch page will always look stunning and accessible.
- π Secure & Private: Your data stays safe with top-notch security and privacy controls, giving you peace of mind while focusing on growth.
We welcome all interested developers to contribute to BioBranch! Whether you're adding features or fixing bugs, your efforts will improve the platform. Follow the steps below to get started:
- Fork the Repository:
- Go to the repository on GitHub and click "Fork."
- In the dropdown, choose "+ Create a new Fork" and click "Create Fork."
- Clone the Forked Repository:
- From your forked repo, copy the URL:
https://github.com/<your-username>/bio-branch.git
- Clone the repository to your local machine:
git clone https://github.com/<your-username>/bio-branch.git cd bio-branch
- From your forked repo, copy the URL:
-
Add Remote Upstream:
- Add the original repository as an upstream remote to sync future changes:
git remote add upstream https://github.com/subhadipbhowmik/bio-branch.git
- Add the original repository as an upstream remote to sync future changes:
-
Verify Remotes:
- Check that your origin and upstream remotes are set correctly:
git remote -v
- Check that your origin and upstream remotes are set correctly:
-
Sync with Upstream:
- Pull the latest changes from the upstream repository:
git pull upstream main
- Pull the latest changes from the upstream repository:
-
Install Dependencies:
- For backend changes:
cd server npm install npm start
- For frontend changes:
cd site npm install npm run dev
- For backend changes:
-
Create a Feature Branch:
- Create a new branch for your changes:
git checkout -b <feature-branch>
- Create a new branch for your changes:
-
Make Changes and Track Them:
- After making changes, track them:
git status git diff
- After making changes, track them:
-
Commit Your Changes:
- Stage and commit your changes:
git add . git commit -m "Add feature: <description>"
- Stage and commit your changes:
-
Push Your Changes:
- Push your feature branch to your remote repository:
git push -u origin <feature-branch>
- Push your feature branch to your remote repository:
-
Create a Pull Request:
- Go to your forked repository, click "Compare & pull request," provide a title and description, and submit the PR.
π Congratulations! Youβve made a PR to BioBranch. Wait for it to be reviewed and merged by a maintainer.
- Ensure that the code you write follows best practices and is well documented.
- Test your changes before submitting a pull request.
- Keep your branch updated with the main branch to avoid conflicts.
- Be clear and concise in your pull request titles and descriptions.
Give this project a β if you find it engaging and helpful! Feel Free to reach out.