Portfolio Builder is a user-friendly React-based application that empowers users to effortlessly create personalized portfolio websites by simply filling out a user-friendly form.
Before you can start contributing to PortfolioBuilder, you need to set up your development environment. Follow these steps to get started:
-
Node: Ensure you have Node installed. You can download Node from here.
-
Git: Make sure you have Git installed. If not, you can download it here.
-
GitHub Account: You will need a GitHub account to contribute to this project. If you don't have one, you can sign up here.
- Fork the PortfolioBuilder repository to your GitHub account by clicking the "Fork" button on the top-right corner of the repository page.
-
Clone your forked repository to your local machine using the following command:
git clone https://github.com/<your-username>/PortfolioBuilder.git
-
Navigate to the project directory and install the required dependencies using Node package manager:
cd frontend npm install
cd backend npm install
-
You can now run the app using the following command:
cd frontend npm start
cd backend npm start
We welcome all contributions, big or small. Here's how you can contribute to PortfolioBuilder:
-
Pick an Issue: Check out our Issues page to find a task that interests you.
-
Make Changes: Make your changes or improvements to the code.
-
Test Locally: Ensure that your changes work as expected and do not introduce any new issues.
-
Commit Changes: Commit your changes with a clear and concise commit message.
-
Push Changes: Push your changes to your fork on GitHub.
-
Create a Pull Request: Open a pull request from your fork to the
main
branch of the original repository. -
Review and Feedback: Your pull request will be reviewed by our team. Make any necessary changes based on feedback.
-
Merge: Once your pull request is approved, it will be merged into the main project.
Thank you for participating in Portfolio Builder Hacktoberfest. We appreciate your contributions, and together, we can make PortfolioBuilder even better for college students everywhere. If you have any questions or need assistance, feel free to reach out to us via GitHub issues or our community chat.
Happy coding! 🚀🎉