|
1 | 1 | # OpenWebSheet |
2 | | -OpenSource Web based spreadsheet |
3 | 2 |
|
4 | | -[<img src=https://github.com/SiamandMaroufi/OpenWebSheet/workflows/CI/badge.svg />](https://github.com/SiamandMaroufi/OpenWebSheet/actions?query=workflow%3ACI) |
| 3 | +OpenWebSheet is an open-source, web-based spreadsheet application. It runs in the browser, can be installed as a Progressive Web App (PWA), and stores spreadsheet documents in the project’s `.ows` format. |
5 | 4 |
|
6 | | - |
7 | | -### Installed PWA: |
| 5 | +[<img src="https://github.com/SiamandMaroufi/OpenWebSheet/workflows/CI/badge.svg" alt="CI status" />](https://github.com/SiamandMaroufi/OpenWebSheet/actions?query=workflow%3ACI) |
8 | 6 |
|
9 | | -<img src="https://siamandmaroufi.github.io/OpenWebSheet/demo.png" /> |
| 7 | +## Demo and PWA installation |
10 | 8 |
|
11 | | -##### for installing the pwa app click on install icon at the url bar's right side |
| 9 | +<img src="https://siamandmaroufi.github.io/OpenWebSheet/demo.png" alt="OpenWebSheet demo" /> |
12 | 10 |
|
13 | | -1. <a href="https://siamandmaroufi.github.io/OpenWebSheet/" >Install</a> the PWA application <br /> |
14 | | -2. <a href="https://siamandmaroufi.github.io/OpenWebSheet/demo/DEMO.ows" download="download" target="_blank" >Download</a> the `demo.ows` sample file |
15 | | -3. click on load *Folder Icon* and load the sample file |
| 11 | +1. Open the hosted app: <https://siamandmaroufi.github.io/OpenWebSheet/> |
| 12 | +2. Install the PWA using the install icon in the browser address bar. |
| 13 | +3. Download the sample file: <https://siamandmaroufi.github.io/OpenWebSheet/demo/DEMO.ows> |
| 14 | +4. Use the folder/load icon in the app to open the sample `.ows` file. |
16 | 15 |
|
| 16 | +## Features |
17 | 17 |
|
| 18 | +- Canvas-based spreadsheet rendering |
| 19 | +- Basic cell content editing |
| 20 | +- Borders |
| 21 | +- Merge and split cells |
| 22 | +- Basic formula support |
| 23 | +- Import/export support for the native `.ows` format |
| 24 | +- PWA support |
18 | 25 |
|
| 26 | +## Roadmap |
19 | 27 |
|
20 | | -### Roadmap |
21 | | - |
22 | | -* [x] basic structure |
23 | | -* [x] canvas rendering |
24 | | -* [x] basic content editor |
25 | | -* [x] borders |
26 | | -* [x] merge and split |
27 | | -* [ ] formula and expressions |
28 | | - * [x] Basic Support |
29 | | - * [ ] Advanced features |
30 | | -* [x] import/export |
31 | | - * [x] Mathematical formulas |
32 | | - * [ ] Open office format support |
33 | | -* [ ] advanced ui features |
| 28 | +- [x] Basic structure |
| 29 | +- [x] Canvas rendering |
| 30 | +- [x] Basic content editor |
| 31 | +- [x] Borders |
| 32 | +- [x] Merge and split |
| 33 | +- [ ] Formula and expressions |
| 34 | + - [x] Basic support |
| 35 | + - [ ] Advanced features |
| 36 | +- [x] Import/export |
| 37 | + - [x] Mathematical formulas |
| 38 | + - [ ] OpenOffice/OpenDocument format support |
| 39 | +- [ ] Advanced UI features |
34 | 40 |
|
| 41 | +## Project setup |
35 | 42 |
|
| 43 | +Install dependencies: |
36 | 44 |
|
37 | | -## Project setup |
38 | | -``` |
| 45 | +```sh |
39 | 46 | npm install |
40 | 47 | ``` |
41 | 48 |
|
42 | | -### Compiles and hot-reloads for development |
43 | | -``` |
| 49 | +Start the development server: |
| 50 | + |
| 51 | +```sh |
44 | 52 | npm run serve |
45 | 53 | ``` |
46 | 54 |
|
47 | | -### Compiles and magnifies for production |
48 | | -``` |
| 55 | +Build for production: |
| 56 | + |
| 57 | +```sh |
49 | 58 | npm run build |
50 | 59 | ``` |
51 | 60 |
|
52 | | -### Run your tests |
53 | | -``` |
54 | | -npm run test |
55 | | -``` |
| 61 | +Run linting: |
56 | 62 |
|
57 | | -### Lints and fixes files |
58 | | -``` |
| 63 | +```sh |
59 | 64 | npm run lint |
60 | 65 | ``` |
61 | 66 |
|
62 | | -### Run your unit tests |
63 | | -``` |
| 67 | +Run unit tests: |
| 68 | + |
| 69 | +```sh |
64 | 70 | npm run test:unit |
65 | 71 | ``` |
| 72 | + |
| 73 | +## Documentation |
| 74 | + |
| 75 | +Additional documentation is available in the [`docs/`](docs/) directory: |
| 76 | + |
| 77 | +- [Development guide](docs/development.md) |
| 78 | +- [Architecture overview](docs/architecture.md) |
| 79 | +- [User guide](docs/user-guide.md) |
| 80 | +- [Supported formats](docs/supported-formats.md) |
| 81 | + |
| 82 | +## Contributing |
| 83 | + |
| 84 | +1. Create an issue or choose an existing one. |
| 85 | +2. Create a focused branch for the change. |
| 86 | +3. Keep changes small and reviewable. |
| 87 | +4. Run linting and tests before opening a pull request. |
| 88 | +5. Update documentation when behavior, setup, or architecture changes. |
| 89 | + |
| 90 | +## License |
| 91 | + |
| 92 | +No license file is currently included in the repository. Add one before publishing or reusing the project in environments that require explicit licensing terms. |
0 commit comments