|
4 | 4 |
|
5 | 5 | ## Installation instructions |
6 | 6 |
|
7 | | -First you have to obtain a patched tabulate-java: |
| 7 | +> [!NOTE] |
| 8 | +> Most up-to-date informations can always be inferred from the GitHub Action |
| 9 | +> which is used to build and deploy this project. |
8 | 10 |
|
9 | | -```shell |
10 | | -git clone [email protected]:tabulapdf/tabula-java.git |
11 | | -cd tabula-java/ |
12 | | -# Fish shell syntax! |
13 | | -git apply (curl https://raw.githubusercontent.com/sp1ritCS/tabula-rs/master/0001-add-ffi-constructor-to-CommandLineApp.patch | psub) |
14 | | -mvn compile assembly:single |
15 | | -``` |
| 11 | +**Prerequisites**: |
16 | 12 |
|
17 | | -# Vue 3 + TypeScript + Vite |
| 13 | +* `nodejs` |
| 14 | +* `pnpm` |
| 15 | +* `rust` >= 1.78.0 |
| 16 | + * including the `wasm32-unknown-unknown` target |
18 | 17 |
|
19 | | -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. |
| 18 | +**Setup**: |
20 | 19 |
|
21 | | -## Recommended IDE Setup |
| 20 | +Run `pnpm install` to install all dependencies. |
| 21 | +Afterwards, run `pnpm exec wasm-pack build` |
| 22 | +to generate the WASM package of grater. |
22 | 23 |
|
23 | | -- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). |
24 | | - |
25 | | -## Type Support For `.vue` Imports in TS |
26 | | - |
27 | | -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types. |
28 | | - |
29 | | -If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps: |
30 | | - |
31 | | -1. Disable the built-in TypeScript Extension |
32 | | - 1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette |
33 | | - 2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)` |
34 | | -2. Reload the VSCode window by running `Developer: Reload Window` from the command palette. |
| 24 | +You should now be ready to run `pnpm run dev`. |
0 commit comments