Skip to content

FriendCode/gitrap

Repository files navigation

Screen

Distributed Git based Forums.

gitrap is for forums what gh-pages is for websites

Code Now

GitRap allows you to store conversations with your collaborators in your GIT repositories (in a specific branch named "gitrap").

This GitRap client runs entirely in your browser (no backend needed) and uses GitHub's API to read/write data to and from the branch "gitrap" of your repositories. The concept of GitRap is not related to GitHub and can be used with any GIT repositories but not in this client-side application.

Try it: friendcode.github.io/gitrap/

Screen Login Screen Login Screen Post Screen Tree Screen Message

How does it work ?

FileSystem layout

It's really simple : GitRap uses a separate branch named "gitrap" in the source repository to store all the conversations as trees

[branch gitrap] /
    1377878509004/
        README.md   : content of the message
        photo1.jpg  : file Attachment
        photo2.jpg  : file Attachment
        1377878744650/  : sub-message 1
            README.md   : content of the sub message
        1377878744680/  : sub-message 2
            README.md   : content of the sub message
    1377878509104/
        README.md   : content of a second message

Overall Design

Screen Design

Install

This is a simple client-side application built using hr.js, you can use it at : friendcode.github.io/gitrap/.

Install and build on your local machine :

git clone https://github.com/FriendCode/gitrap.git
cd gitrap
npm install .
make

Todo :

  • File Attachments
  • Interval refresh
  • Improve UI design and messages design
  • Correct messages order using commit date