UPDATE: Update documentation

This commit is contained in:
Nicolás Hatcher
2025-02-06 20:35:05 +01:00
committed by Nicolás Hatcher Andrés
parent dc8bb6da21
commit f96481feb8
3 changed files with 18 additions and 14 deletions

View File

@@ -7,6 +7,15 @@ https://www.npmjs.com/package/@ironcalc/wasm?activeTab=readme
## Building ## Building
Dependencies:
* Rust
* wasm-pack
* TypeScript
* Python
* binutils (for make)
```bash ```bash
make make
``` ```

View File

@@ -14,9 +14,8 @@ npm install
## Local development ## Local development
```bash ```bash
npm run dev npm run storybook
``` ```
## Linter and formatting ## Linter and formatting
@@ -39,20 +38,9 @@ npm run test
Warning: There is only the testing infrastructure in place. Warning: There is only the testing infrastructure in place.
## Deploy ## Build package
Deploying is a bit of a manual hassle right now:
To build a deployable frontend:
```bash ```bash
npm run build npm run build
``` ```
Please copy the `inroncalc.svg` icon and the models you want to have as 'examples' in the internal 'ic' format.
I normally compress the wasm and js files with brotli
```
brotli wasm_bg-*****.wasm
```
Copy to the final destination and you are good to go.

7
webapp/README.md Normal file
View File

@@ -0,0 +1,7 @@
# WebApp
The folder app.ironcalc.com contains the frontend and backend code deployed at https://app.ironcalc.com
The folder IronCalc contains the actual code for the spreadsheet widget as found in:
https://www.npmjs.com/package/@ironcalc/workbook