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.
- Live: BioBranch
- We welcome all interested developers to contribute in improving BioBranch and start building your own BioBranch profile to simplify the way you share your digital footprint! Whether you're adding features or fixing bugs, your contributions will make this project better.
- Follow the steps below to get started:-
-
Fork the Repository:
-
Go to the repository on GitHub and click the "Fork" button.
- Dropdown menu --> "+ Create a new Fork"
- Dont change the suggested repo name and just click on "Create Fork" button.
- Congratulations! 🎊 you have successfully created a copy of our repo!🎊
-
-
Now, from your forked repo, click on the "<> code" button and copy the url:
- the forked url looks like this
https://github.com/<your username>/bio-branch.git
-
Open your IDE(Visual studio code or other), paste the above url in vs code terminal or git bash and navigate into the directory:
git clone https://github.com/<your username>/bio-branch.git cd bio-branch
-
Add a Remote upstream to original repo for reference:
-
In this way, you can feasibly update your forked repo with the original repo changes. Ensure you execute this cmd in the "bio-branch" directory
git remote add upstream https://github.com/subhadipbhowmik/bio-branch.git
-
Verify remote origin and upstream:
git remote -v
- the following response appear:
origin https://github.com/<your username>/bio-branch.git (fetch)
origin https://github.com/<your username>/bio-branch.git (push)
upstream https://github.com/subhadipbhowmik/bio-branch.git (fetch)
upstream https://github.com/subhadipbhowmik/bio-branch.git (push) - Always make a pull from the upstream repository to your main branch to keep it updated with the original repository.
- Ensure you are in the main bio-branch directory
git pull upstream main
- Install the dependencies:
-
Backend changes:
cd server npm install / yarn start npm start -
Now-
Server is running at http://localhost:4000 -
Frontend changes:
cd site npm install npm run dev # or yarn dev # or pnpm dev
-
Now, the frontend is running locally-
ready - started server on 0.0.0.0:3000, url: http://localhost:3000You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.
-
Create a new branch:
git checkout -b <feature-branch>
-
Work on the issue:
- Perform the proposed changes in your new branch and ensure everything works.
-
Track your changes:
git status git diff
-
Stage and Commit your changes:
git add .
git commit -m "Add feature: <description>"- Ensure you push the committed changes in your feature branch to your own remote repository
git push -u origin <feature-branch>
- Next, create a Pull Request
- Go to your forked repository on GitHub, click "Compare & pull request."
- Provide a descriptive title and summary for your PR.
- Click on "Create pull request" to submit your PR for review!
- 🎇 Hurray!🎉, you have made a PR to the BioBranch. Sit back and wait for your submission to be accepted and your PR to be 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.