Skip to content

quick-start.md

Latest commit

 

History

History
36 lines (26 loc) · 1.28 KB

quick-start.md

File metadata and controls

36 lines (26 loc) · 1.28 KB

Quick Start Guide

Welcome to OpenCodeHub! This guide will help you navigate the platform and start collaborating in minutes.

1. Login

Navigate to your instance URL (e.g., http://localhost:3000) and log in with the admin credentials you created during installation.

Login Screen

2. Navigating the Dashboard

Your dashboard gives you a quick overview of:

  • Recent Repositories: Projects you've worked on recently.
  • Your Pull Requests: PRs requiring your attention.
  • Activity Feed: What your team is doing.

3. Create a Repository

  1. Click the + (Plus) icon in the top right navigation bar.
  2. Select New Repository.
  3. Enter a Repository Name (e.g., my-awesome-project).
  4. Choose Visibility:
    • Public: Visible to everyone (if your instance allows it).
    • Private: Visible only to you and collaborators.
  5. Click Create Repository.

4. Collaborate

  1. Invite Members: Go to Settings > Collaborators to add team members.
  2. Create Issues: Use the Issues tab to track tasks and bugs.
  3. Open Pull Requests: Push a branch and open a PR to review code.

Next Steps

Now that you're exploring the UI, try pushing your first code:

👉 Create Your First Repository