Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 1.9 KB

README.md

File metadata and controls

85 lines (52 loc) · 1.9 KB

codecov

Giproxy

Giproxy is a lightweight proxy server designed to facilitate interactions with Git providers (like GitLab, GitHub, and Bitbucket). The tool simplifies and unifies API requests, making integration with various Git services effortless.


Features

  • Unified interface for multiple Git providers
  • Lightweight and fast
  • Extensible architecture for new providers
  • Easy to use with minimal configuration

Development

To set up the development environment and start working on Giproxy, follow these steps:

Prerequisites

Install Dependencies

Run the following command to install the necessary dependencies:

make install

This will ensure all Go modules are downloaded and ready.

Developer Mode

To start the project in developer mode with hot-reloading:

make watch

This will automatically restart the application whenever changes are detected in the source code.

Standard Run

If you want to manually start the application without hot-reloading:

make run

Build

To build the project and generate an executable binary:

make build

The built binary will be available in the bin/ directory.


API Documentation

API documentation for Giproxy is currently under development. Stay tuned for updates.


Contribution

Contributions are welcome! Please follow the guidelines below:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature-branch)
  3. Commit your changes (git commit -m 'Add some feature')
  4. Push to the branch (git push origin feature-branch)
  5. Open a pull request