Getting Started

Now Gitoak offers two installation methods: using the release version or from source code. Choose the method that best suits your needs.

Install from Release (Recommended)

  1. Download the latest version gitoak-v0.3.0.zip from GitHub Releases
  2. Extract the downloaded zip file to any location on your computer
  3. Follow these steps based on your browser:

Chrome/Edge:

  1. Navigate to chrome://extensions/
  2. Enable "Developer mode" in the top right corner
  3. Click "Load unpacked"
  4. Select the extracted GitOak folder

Install from Source Code

  1. Clone the repository and build the project:

    git clone https://github.com/your-repo/gitoak.git
    cd gitoak
    npm install
    npm run build
    
  2. Follow the browser installation steps above, selecting the dist_chrome directory for installation

Verify Installation

After installation, you can verify it was successful by:

  • Checking if the GitOak icon appears in your browser's extension bar
  • Visiting any GitHub repository page to confirm GitOak features are loading correctly

Common Issues

  • If the extension doesn't appear after installation, try refreshing the page
  • If you encounter permission issues, ensure Developer mode is enabled
  • If features aren't working, verify your browser version is supported

Support

If you encounter any issues during installation:

  • Check the FAQ
  • Submit an issue on GitHub Issues
  • Contact the technical support team here

We hope this installation guide helps you get started with GitOak. If you have any questions or suggestions, please feel free to provide feedback.