Documentation

GitHub Setup & Updates

Configure your GitHub repository and sync with CodeBaseHub updates.

Set Your Repository

After cloning CodeBaseHub, configure it to use your own GitHub repository:

# Set your repository URL
git remote set-url origin https://github.com/yourname/yourproject.git

# Verify the change
git remote -v

You should see your repository URL in the output. Now push your code:

git push -u origin main

Sync with CodeBaseHub Updates

To receive updates from the original CodeBaseHub repository:

# Add CodeBaseHub as upstream
git remote add upstream https://github.com/CodeBaseHubTeam/CodeBaseHub-Starterkit.git

# Pull updates from CodeBaseHub
git pull upstream main --allow-unrelated-histories --rebase

Workflow Tips

  • Regular updates: Run the upstream pull command periodically to get the latest features and fixes
  • Conflicts: If you have custom changes, resolve conflicts during the rebase
  • Your changes: Always commit your changes before pulling updates
  • Backup: Consider creating a backup branch before major updates

Verify Setup

Check your remotes are configured correctly:

git remote -v

Should show:

  • origin → your repository
  • upstream → CodeBaseHub repository