radicle-surf

A code surfing library for Git repositories 🏄‍♀️🏄‍♂️

Welcome to radicle-surf!

radicle-surf is a library to describe a Git repository as a file system. It aims to provide an easy-to-use API to browse a repository via the concept of files and directories for any given revision. It also allows the user to diff any two different revisions.

One of the use cases would be to create a web GUI for interacting with a Git repository (thinking GitHub, GitLab or similar systems).

Contributing

To get started on contributing you can check out our developing guide, and also our LICENSE file.

The Community

Join our community disccussions at radicle.community!

lib.rs:

radicle-surf is a library to help users explore a Git repository with ease. It supports browsing a repository via the concept of files and directories, or via blobs and trees in a git fashion. With the additional support of diff::Diff and History, this library can be used to build an intuitive UI for any Git repository.

The main entry point of the library API is Repository.

Let's start surfing!

Serialization with feature serde

Many types in this crate support serialization using Serde through the serde feature flag for this crate.