lulzzz / chasm Goto Github PK

Chasm

   ______  ____  ____       _       ______   ____    ____  
 .' ___  ||_   ||   _|     / \    .' ____ \ |_   \  /   _| 
/ .'   \_|  | |__| |      / _ \   | (___ \_|  |   \/   |   
| |         |  __  |     / ___ \   _.____`.   | |\  /| |   
\ `.___.'\ _| |  | |_  _/ /   \ \_| \____) | _| |_\/_| |_  
 `.____ .'|____||____||____| |____|\______.'|_____||_____| 

CAS = Content Addressable Storage

Wikipedia

"CAS, is a mechanism for storing information that can be retrieved based on its content, not its storage location. It is typically used for high-speed storage and retrieval of fixed content"

Git is a well-known example of a product that uses CAS. However Chasm does not aim to be a Git replacement. For example, there is no concept of a working tree. Rather, this is meant to be a general purpose CAS store for any document type.

Requirements

• CAS: Self-versioned, immutable store.
• Single-instance storage of data: If two authors create the exact same documents, their repos should not differ in Object data.
• Efficient network/disk operations: XML is bad, JSON is better, Protobuf/etc are best
• Simple: Avoid the need to reinvent graph semantics, etc

Prerequisites

• .NET Core SDK 2.2 (https://www.microsoft.com/net/download/core)

Getting started

Getting started with Git and GitHub

• People new to GitHub should consider using GitHub for Windows.
• If you decide not to use GHFW you will need to:

1. Set up Git and connect to GitHub
2. Fork the Chasm repository

• Finally you should look into git - the simple guide

Rules for Our Git Repository

• We use "A successful Git branching model". What this means is that:
  • You need to branch off of the develop branch when creating new features or non-critical bug fixes.
  • Each logical unit of work must come from a single and unique branch:
    • A logical unit of work could be a set of related bugs or a feature.
    • You should wait for us to accept the pull request (or you can cancel it) before committing to that branch again.

License

Chasm is licensed under the MIT license, which can be found in LICENSE.

Additional Restrictions

• We only accept code that is compatible with the MIT license (essentially, MIT and Public Domain).
• Copying copy-left (GPL-style) code is strictly forbidden.