riel-foundation / riel

Riel source code

Riel: A Version Control System

Version control system inspired by CRDT (Conflict-Free Resolution Data-Types) concepts

State: Not ready for production yet

Current features:

Adding, commiting, pseudo-random commit hashing, cloning using an https request via a tcp stream

Alpha to-do list (Almost there):

• Config
• Remotes
• Thrust (push), load (pull) from remotes

Beta to-do list:

• Author metadata
• Merging
• CRDT algorithm implemented where possible
• Branching

Before release to-do list:

• Compression, deduplication, misc features...
• Documentation
• Tests
• Benchmarks
• Release

Manual installation for Linux:

• Install Rust
• Clone this repository
• Run make dev or make all in root directory
• In short, git clone https://www.github.com/riel-foundation/riel && cd riel && make dev

Repositories structure as a json:

{
  "name": "repository-name",
  "children": [
    {
      "name": ".riel",
      "children": [{"Internal metadata is not clearly defined yet?" : "No, it isn't"}]
    },
    {
    "name": "folder1",
    "children": [
                  {
                    "name": "helloworld.rs",
                    "children": [],
                    "url": "https://myserver.local/user/repository-name/folder1/helloworld.rs"
                  }
                ],
    "url": null
    },
    {
    "name": "arootfile.txt",
    "children": [],
    "url": "https://myserver.local/user/repository-name/arootfile.txt"
    },
    {
      "name": ".rielignore",
      "children": [],
      "url": "https://myserver.local/user/repository-name/.rielignore"
    }
  ]
}

riel's Issues

Help for each command and help outside main.rs

This should be pretty simple to do. But might be a problem to add support for translations later on

Non UTF8 bytes clones

Files which can't be displayed as plain utf8 text will not display properly, and probably, a emoji in a comment could break the cloning, making Rust panic. A function that should fix this is already in remotes/tcp_web.rs as a TODO placeholder

Commit metadata

As with git, commits should contain metadata on their own, to keep track on who did what.
This is simply not done yet

Getting home directory

For Riel not to be unix-only, there has to be a way to use something like this function but without unexpected behavior