GitRoot

  1GitRoot is a small yet powerfull git forge. Download one binary, launch it and you have a forge that can :
  2
  3- create git repositories
  4- manage who can access to what repositories
  5
  6Nothing more, nothing less.
  7
  8Install plugins and you will be able to:
  9
 10- create issues, roadmap, sprint, milestone...
 11- represent them in boards
 12- review/merge branches (called grafts in gitroot)
 13- represent them all and many more in a web interface
 14
 15> All of these plugins are completely independant. Yes, you can have boards without the web interface. How ? [See raw GitRoot issues board](https://gitroot.dev/gitroot/worktree/boards/issues.md.html), try it for yourself and you will love it.
 16
 17**Wants more? Build your own plugin!**
 18
 19# Why am I doing this?
 20
 21I'm building GitRoot because I didn't find any tool that can let me do what I want for my project. But at the same time, you may want to make something different for your own project, something different of my idea of a perfect project.
 22
 23Every project is unique, so why don't we have the freedom to modify our forge to suit our own project ?
 24
 25So I try to follow these rules when developing my forge:
 26
 27## As a developer I want:
 28
 29- a repository containing all my data: code, issues, `(pull|merge)-request`, boards
 30- all I need to promote my project: landing page, translation, ticketing, forum
 31- the ability to migrate my project into a new server forge: no script migration, no loose data, no loose attribution
 32
 33> As a developer I want to have a forge crafted for my unique project.
 34
 35## As a developer I don't want:
 36
 37- to open my browser to manage my data: `(pull|merge)-request`, issues
 38- the first representation of my project is a list of files and directories
 39- my forge chooses my workflow issues: what is a sprint vs a milestone vs an epic vs an user-story?
 40- to have 100 menus to configure who can do what
 41
 42> As a developer I don't want a complexe forge to manage my project.
 43
 44## As an administrator I want:
 45
 46- an easy to deploy forge: no dependency, no database
 47- to configure what my users can do
 48- my users can request what they want: no need to send email/chat to create or access to a project or a feature
 49
 50> As an administrator I want a forge that is easy to install and to maintain.
 51
 52## As an administrator I don't want:
 53
 54- headaches to upgrade my forge
 55- to give my data (or user data) to someone else
 56- to depend on big players who can table-flip their forge at any time
 57
 58> As an administrator I don't want to depend on anyone else.
 59
 60### _If you are like me, you will love GitRoot._
 61
 62It's not ready yet, but it will be, especially if you give me a hand.
 63
 64# How it works?
 65
 66In GitRoot everyting is stored in git, not in a database, not in a hidden blob in your git tree. Everything is stored in plain files aside your code.
 67
 68How can you be sure no one writes on a file that they must not? **Restrict by branch.** Every GitRoot repository comes with a `.gitroot/users.yml` file. This file gives the instructions to GitRoot who can write where.
 69
 70Initially, you're the only one to have access to your [default branch](./docs/technicals/default_branch.md). If someone else tries to push to this branch, GitRoot will refuse its modifications.
 71
 72However, everyone can create a branch. When creating and pushing a branch, GitRoot will add right for this user to this branch. This means that no one else will be able to modify it.
 73
 74If you add a user, by editing `.gitroot/users.yml` or by merging a branch where a user has added itself, this user will be able to push to the [default branch](./docs/technicals/default_branch.md).
 75
 76All GitRoot features are articulated around this concept. This means that everyone can read files and modify them, locally or into a new branch. But only the owner can merge them in the [default branch](./docs/technicals/default_branch.md) which represent the current state of your repository.
 77
 78As your forge is managed by a root repository, this concept permit to manage everything on your own forge: a repository is created when you add (or merge) a change of `.gitroot/repositories.yml` in your [default branch](./docs/technicals/default_branch.md) of your root repository.
 79
 80See more details in the [documentation](./docs/).
 81
 82# When will be it available?
 83
 84GitRoot is currently in **alpha** version. Feel free to experiment with it, but **don't use it for production yet**.
 85
 86GitRoot can:
 87
 88- Create/delete repositories
 89- Accept git command through ssh
 90- Manage users (who can write where on repo/branch level)
 91- Install plugins
 92- Activate plugins for a repository
 93- Run plugins on your worktree at install
 94- Run plugins on diff every commit after install
 95- Visualize repository with http
 96
 97What I want to do before version 1.0:
 98
 99- Update GitRoot and plugins
100- Manage users (who can wright where on file level)
101- Accept git command through http
102- Manage repositories in group and sub-group
103- Stabilise the plugin API
104
105# Where is the project?
106
107Actually, you are currently on the project. Yes this is GitRoot!
108
109Well you are on the instance of GitRoot which hosts the code of GitRoot. Unfortunatly this instance is reserved for GitRoot itself.
110
111If you want to try GitRoot for your own project, please read [the documentation](./doc/index.md).
112
113# How to contribute?
114
115You will find anything you need to know into [the documentation](./doc/index.md). Since GitRoot is itself a GitRoot repository you should be able to contribute to it.
116
117On this instance we use some plugins. For example, the `grafter` plugin which manages how a portion of code can be incorporated into the default branch. So be sure to read [the contributing](./CONTRIBUTING.md) to understand how it works.
118
119And yes, as GitRoot stores all data in git, you need to know how to use git before contributing to this project (code, issue, translation...). In the future I hope to be able to allow to do `git commit` and `git push` commands directly from the browser, so that anybody will be able to participate.