Hackathon Project Submission Guide 🚀

Welcome, Hackathon Participants! 🎉 This guide will walk you through the process of submitting your project to this repository using GitHub. We will cover everything from forking the repository to creating a pull request (PR). Follow these steps carefully to ensure your submission is successful and free of dependency issues.

---

📋 Prerequisites

Before you begin, ensure you have the following:

• A GitHub account.
• Git installed on your local machine.
• Node.js and npm installed (if applicable for your project).
• Basic understanding of Git and GitHub.

---

🚀 Step 1: Fork the Repository

1. Fork this repository:

   • Click on the "Fork" button at the top right corner of this repository page.
   • This will create a copy of this repository under your GitHub account.

2. Clone your forked repository:

   git clone https://github.com/<your-username>/<repository-name>.git

   Replace <your-username> with your GitHub username.

3. Navigate into the cloned directory:

   cd <repository-name>

---

🔄 Step 2: Set Upstream Repository

To keep your fork in sync with the original repository:

1. Add the original repository as an upstream remote:

   git remote add upstream https://github.com/<original-owner>/<repository-name>.git

2. Verify the new upstream remote:

   git remote -v

---

📂 Step 3: Create a Branch for Your Project

1. Pull the latest changes from the main branch:

   git pull upstream main

2. Create a new branch for your hackathon project:

   git checkout -b <team-name>-submission

   Replace <team-name> with your team's name.

---

📦 Step 4: Install Dependencies

To avoid dependency issues:

1. Install project dependencies:

   npm install

2. Check for outdated or missing dependencies:

   • If you encounter any issues, try using:

     npm audit fix

3. Lock package versions:

   • If you are adding new dependencies, ensure you use exact versions to avoid conflicts:

     npm install <package-name>@<version> --save-exact

4. Commit the updated package-lock.json or yarn.lock:

   git add package-lock.json
   git commit -m "Updated dependencies"

---

💻 Step 5: Develop Your Project

Now, build your hackathon project within the newly created branch. Make sure to:

• Write clean, modular, and well-documented code.
• Test your application thoroughly before submission.
• Include relevant documentation for your project in a separate README.md file.

---

🔄 Step 6: Sync with the Upstream Repository

Before submitting your pull request, ensure your branch is up to date:

1. Fetch the latest changes from the upstream repository:

   git fetch upstream

2. Merge changes into your branch:

   git merge upstream/main

3. Resolve any merge conflicts, if they occur.

---

✅ Step 7: Commit and Push Changes

1. Add all your changes:

   git add .

2. Commit your changes with a descriptive message:

   git commit -m "Add hackathon project submission by <team-name>"

3. Push your branch to your forked repository:

   git push origin <team-name>-submission

---

🔄 Step 8: Create a Pull Request (PR)

1. Go to the original repository on GitHub.

2. Click on the "Compare & pull request" button.

3. Ensure your pull request:

   • Targets the main branch of the original repository.
   • Has a clear title and description.
   • Includes relevant details such as your team members, project overview, and any special instructions.

4. Submit your pull request.

---

🛠 Troubleshooting Common Issues

1. Dependency conflicts:

   • Delete node_modules and package-lock.json, then run:

     rm -rf node_modules package-lock.json
     npm install

2. Merge conflicts:

   • Use a merge tool like git mergetool or manually resolve conflicts, then commit the resolved files.

3. Failed builds:

   • Ensure that your project passes all tests and linting checks before submitting.

---

🎉 Congratulations!

You have successfully submitted your hackathon project! 🚀 Thank you for participating, and good luck! 🎊 https://t.me/Lisk_kenya If you have any questions or need further assistance, feel free to reach out to us.

Happy Coding! 💻😊