Klectr/KSlab
1
0
Fork 0
generated from Klectr/KTemplate
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
KSlab is a infinite canvas that runs locally, not making any network requests
80 Commits 5 Branches 0 Tags 1.1 MiB
TypeScript 93.2%
CSS 2.7%
JavaScript 2.2%
HTML 1%
Rust 0.9%
f9d0315bd7
Go to file
Triston Armstrong f9d0315bd7
build: add vite plugin checker 
this throws ts errors if any found in project so were not missing anything
2024-10-25 11:19:41 +07:00
.vscode Initial commit 2024-09-28 08:24:39 +00:00
src fix: fix linter and type errors 2024-10-25 11:18:42 +07:00
src-tauri update app name 2024-10-07 02:54:35 -04:00
.gitignore Initial commit 2024-09-28 08:24:39 +00:00
.prettierrc Initial commit 2024-09-28 08:24:39 +00:00
bun.lockb build: add vite plugin checker 2024-10-25 11:19:41 +07:00
eslint.config.js make it so underscore ignores unused vars 2024-10-23 13:27:28 +07:00
index.html feat(favicon): add favicon to page 2024-10-10 04:10:24 -04:00
package.json build: add vite plugin checker 2024-10-25 11:19:41 +07:00
postcss.config.js Initial commit 2024-09-28 08:24:39 +00:00
README.md update readme with some boilerplate content 2024-10-23 13:47:59 +07:00
tailwind.config.js fix(images): adds a toaster and handles failed image inserts 2024-10-10 03:35:35 -04:00
tsconfig.json make it so underscore ignores unused vars 2024-10-23 13:27:28 +07:00
vite.config.ts build: add vite plugin checker 2024-10-25 11:19:41 +07:00

README.md

Kslab

A visual organization tool for notes, text, shapes, and images.

Table of Contents

Screenshots

screenshot

Technologies

This project utilizes the following open-source libraries:

  • Kaioken: A lightweight UI rendering library (Kaioken)
  • Tauri: A framework for building desktop and mobile applications with web technologies (https://v2.tauri.app/)
  • TypeScript: A typed superset of JavaScript that adds optional static typing
  • ESLint: A linter for enforcing code style and catching potential errors

Development Setup

  1. Clone the repository: 
    git clone https://git.klectr.dev/Klectr/kslab.git
  2. Install dependencies: This project uses Bun as its package manager. 
    bun install

Installation

Desktop Application

[Instructions on how to download, install, and run the desktop application. Mention any dependencies or prerequisites.]

Note: These instructions might involve installing Tauri and any additional dependencies for the desktop application.

Web Application

[Instructions on how to access and use the web application. Specify if it's a standalone web app or runs within Tauri.]

Note: These instructions might involve running the web application directly in a browser if it's standalone.

Usage

Desktop Application

  • Add notes: Click the "+" button to create a new note.
  • Edit notes: Double-click a note to edit its content.
  • Move notes: Drag and drop notes to reposition them on the canvas.
  • Add shapes and images: Use the toolbar to add various shapes and images.
  • Customize appearance: Change the color, size, and other properties of elements.

Web Application

[Instructions for using the web application, similar to the desktop application]

Contributing

[Guidelines for contributors, including how to report bugs or submit pull requests. Mention how contributions to both Kaioken and Tauri integrations are handled. Also, emphasize the importance of following TypeScript and ESLint conventions.]

License

[Specify the license under which the project is released (e.g., MIT, Apache License 2.0)]

Additional sections you might consider:

  • Roadmap - Future plans for Kslab, such as implementing an infinite canvas or adding more features.

Remember to replace the placeholder text with specific details about your project.

Let me know if you'd like help filling in any specific sections or if you have any further questions about Kaioken, Tauri, TypeScript, or ESLint.