Developer Documentation

Documentation on how to contribute and stuff lol.

Scribe is a Tauri Typescript application. It does not use any UI frameworks (like React, Svelte, etc) and uses vanilla HTML, CSS, and Typescript. HTML for UI, CSS for making the UI actually look good, and Typescript for logic.

This is not a tutorial on how to use any of the above.

Compiling

Requirements

A decent knowledge on HTML, CSS, and Typescript (If I see one line of Javascript in a PR I will immediately close it.) Knowledge on node.js Knowledge on how Tauri works.

There are two main ways to do this:

Method 1: Jetbrains Webstorm

Webstorm is what I use to write the program, and is free for non-commercial use (this project is non-commercial).

Webstorm is the recommended option since it includes everything out of the box.

Step 1: Install Webstorm

Step 2: Install Git

Step 3: In Webstorm, it will say that you have a free trial of Commercial. Please go to "Manage Licenses", create a jetbrains account if you don't have one, and register for a non-commercial license (its free).

Step 4: In the menu you see when first opening Jetbrains, click "Clone a Repository"

Step 5: Enter https://github.com/Axolotlguy7707/Scribe.git

Step 6: Open the Project and run npm install. This will install all packages used by the app.

Step 7: If not done automatically, Install Rust.

IMPORTANT:

The app doesn't use any Rust in the logic for the app itself. Tauri, the framework that is used to make the app a desktop app, uses Rust as a backend. In order to build the application from source, Rust is needed for Tauri.