B.3 | Frameworks#
[1] rivt frameworks#
rivt interoperates with a large number of external programs that improve its user interface and capabilities. The documented frameworks include rivt-code and rivt-framework.
[2] rivt-code#
rivt-code includes VSCode VSCode <https://code.visualstudio.com/> for editing and managing rivt-docs. rivt-code is a local portable installation.
Purpose |
Link |
|---|---|
Editing |
|
rivt Extensions |
[2] VSCode and rivt-codespaces#
CodeSpaces is a cloud based GitHub implementation of VSCode with a large set of extensions, including collaboration and versioning support.
Purpose |
Link |
|---|---|
Editing |
|
rivt Extensions |
|
Version Control |
GitHub Codespaces is a VSCode cloud-based development environment connected to GitHub files. It can be set up with rivt extensions that provide a complete rivt editing and collaboration environment in the cloud.
rivt-codespace is a cloud based rivt installation that may be forked into a personal GitHub repository.
[3] rivt Collaboration#
Collaboration is facilitated by the Visual Studio Live Share. You can start a Live Share session either within CodeSpaces in your browser, or within the VS Code desktop application.
The Live Share extension enables:
Real-time Co-editing: Multiple participants can work on the same file simultaneously, seeing each other’s cursors, selections, and edits instantly, much like in Google Docs..
Shared Terminals and Servers: The host can share their terminal and localhost servers with guests, eliminating the need for guests to set up their own environments or dependencies.
Navigation and Following: Participants can independently navigate the project or choose to “follow” another collaborator, keeping their editor synchronized with the leader’s actions.
File Access Control: Hosts can use a .vsls.json file to control which files and folders are visible or editable by guests, ensuring security and focus
[4] git#
Git is a free, open-source distributed version control system designed to track changes in source code during software development. It allows multiple programmers to collaborate on the same project simultaneously without overwriting each other’s work.
Key Functions
Track changes: Records every modification made to a project’s files over time.
Revert history: Restores previous file versions easily if errors or bugs are introduced.
Enable collaboration: Merges independent updates from multiple team members into a single codebase.
Work offline: Provides each developer with a complete local copy of the full project history.
Essential Concepts
Repository (Repo): The tracking folder where your project files and their revision histories live.
Commit: A permanent saved snapshot of your staged files at a specific point in time.Branch: An isolated environment used to develop new features without altering the stable main code.
Merge: The automated process of combining changes from one branch back into another.
Core Workflow
The core workflow in a local or remote Git project transitions through four distinct environments before saving:
Working Directory: The actual files you are modifying on your computer.
Staging Area: A temporary holding zone where you select and prepare changes for the next snapshot.
Local Database: The final destination where commits are permanently saved to your project history.
Push: Copy local database to remote repository e.g. GitHub
[5] Extended framework#
The rivt extended framework includes additional programs and libraries for formatting, drawing, diagramming and calculating.