Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pavi2410 committed Mar 31, 2024
1 parent f2ab742 commit fa46f76
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
# Tauri + Vue 3 + TypeScript
# Jigsaw

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
**Jigsaw** is a powerful desktop application developed by **Kodular** that empowers you to create mobile apps with ease. Using a visual **Blockly** interface, Jigsaw allows you to piece together your app's functionality like solving a puzzle.

## Recommended IDE Setup
## Features

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
- **Visual Programming**: No need to write complex code! Jigsaw's intuitive Blockly interface lets you drag and drop blocks to create app logic.
- **Cross-Platform**: Build apps for Android and iOS simultaneously.
- **Component Library**: Access a rich library of pre-built components for UI, data handling, and more.
- **Real-Time Preview**: See your app come to life instantly as you design it.
- **Export APK/IPA**: Generate APK files for Android and IPA files for iOS.

## Getting Started

1. **Installation**: Download and install Jigsaw from the official website.
2. **Create a New Project**: Start a new project and choose your app's name and package ID.
3. **Design Your App**: Use the visual interface to create screens, add components, and define app behavior.
4. **Test Your App**: Preview your app in real-time to ensure everything works as expected.
5. **Export Your App**: Generate the APK or IPA file for distribution.

## Copyright Notice

## Type Support For `.vue` Imports in TS
**Jigsaw** is copyrighted by **Pavitra Golchha**. While you can explore and learn from the app, its use for any commercial purpose is strictly prohibited without explicit permission.

Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
## Contributing

1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
We welcome contributions! If you'd like to enhance Jigsaw or report issues, please check out our contributing guidelines.

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)

You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).

0 comments on commit fa46f76

Please sign in to comment.