Serverless Information Tracker
SIT is a compact tool that helps tracking and sharing information between people and systems in a decentralized, sporadically-online environment (aka "the real world").
Its goal is to lower the barrier for recording, querying and sharing information independently. Instead of having to setup and maintain a server and a database, or having to rely on services of an external third party, SIT is a self-contained binary for Linux, OS X and Windows that typically works on the end-user's computer. SIT's medium of record is files. No external database is required.
What's Up? (Roadmap)
SIT being a new project developed and maintained by a very small number of people, can at times be hard to assess in terms of the direction and ongoing work.
For the time being, we'll be updating this section.
Currently, the most important thing being worked on (and it's getting close to completion) is the deprecation of "items" as a concept and introduction of the global, flat records namespace. This will further the initial transition from the original use of SIT as an issue tracker to a more generally applicable collaborative tracker as it will no longer impose this "item" concept onto end-user modules or applications. This also opens up the path to developing ecosystem tooling like a module manager (already in the works as well).
While bare SIT can track any kind of information (it's all just files, after all), the user experience of using it as is might be less than exciting. For this reason, SIT supports a concept of modules that allows to operate domain-specific workflows and interfaces easily.
Currently available modules:
Why Should I Care?
As far as analogies go, we're doing to information tracking what Git did to version control systems. But let us further elaborate on a few benefits to consider:
- Works offline. You can synchronize information, go offline and work on it without needing a connection. You can synchronize at any time later.
- Contextualizes state. When used together with an SCM (such as Git), you can see the state of any item at any given revision (in the context of issue tracking, for example, it can answer the question of "what release branches is this issue closed on?")
- Continuously localizes data. You can access the data at any time. No API rate limits. It's on your filesystem.
- Adapts to your group topology. Synchronization can be done over Git, Dropbox, Keybase, USB flash drives or anything else that allows you to copy files between computers.
- Malleable. You can make it handle just about any workflow and payload. The customization is in its blood.
It is in the early adopter stage. It's usable but not everything is done yet and some things will change. We're publishing releases regularly but always encourage trying out the latest and greatest master branch.
Originally IT in SIT stood for "issue tracking". Since then, it grew to become a generalized information tracking tool (with issue tracking extracted to a module)
All our releases are hosted on GitHub and binary files can be downloaded from there.
You can also use this oneliner to install it for your local user:
curl -s https://sit.fyi/install.sh | sh
Please note that while this is a convenient way to install SIT, it is not the most secure one because you're trusting install.sh to not do any harm. We're doing our best (within reason) to ensure this file isn't hijacked by a malicious actor. If this is a concern for you, please use the links referenced above or build SIT from sources.
As SIT is currently in its early days, sometimes it might make sense to use a pre-release build. We encourage that. It helps us building a better product.
Firstly, you will need to install Rust 1.28 and CMake. Luckily it is typically a very simple process. You can find instructions on Rust's website.
Now, after that has been taken care of, time to check out SIT and build it:
git clone https://github.com/sit-fyi/sit cd sit cargo build --release
Now, you can copy
target/release/sit-web to your
PATH or add
PATH to always have the most
recent version available.
Questions, Bug Reports, etc.?
SIT's is using SIT for tracking issues (duh!) and because of this, GitHub issues are turned off. It's a good excuse to try out SIT if you have an issue to file!
You will get all issue updates when you fetch this git repository. All updates will come through it as well.
sit-web in this repository's clone and open it in the browser.
Send Updates to Upstream
Once you've used sit-web or
sit mr to work on the issues,
you can send the updates to this repository:
- Create a branch (as a convention, you can use your issue ID or an added record ID as a branch name, but free to choose anything else, preferrably unique)
- Add new files in
.sitand commit them. Commit message can be simply "Added issue " or, say, "Commented on issue "
- Send it out to the Inbox:
git send-email --email@example.com master..<branch>
- If the commit only contains new records (nothing else is permitted!) the Inbox will accept the push and immediately forward it to sit's master repository on GitHub. Otherwise, the push will be rejected.
Preparing a merge request
Please refer to CONTRIBUTING for the instruction.
SIT is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT for details.
This project is in its very early days and we will always be welcoming contributors.
Our goal is to encourage frictionless contributions to the project. In order to achieve that, we use Unprotocols' C4 process as an inspiration. Please read it, it will answer a lot of questions. Our goal is to merge patches as quickly as possible and make new stable releases regularly.
In a nutshell, this means:
- We merge patches rapidly (try!)
- We are open to diverse ideas
- We prefer code now over consensus later
To learn more, read our contribution guidelines