js-draw 0.7.1 → 0.7.2

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+
+# 0.7.2
+ * Bug fixes
+   * Fix multi-line text displaying in wrong position in exported SVGs.
+   * Fix editing a different text node sometimes changing the color/font of the previous text node.
+
 # 0.7.1
  * Fix scrollbars in text tool appearing when they should not (mostly in Chrome).
 

package/CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Building and testing
+`js-draw` uses `yarn` as its build system and to manage dependencies. Thus, to install dependencies and build the project for the first time,
+```bash
+# After cloning the project,
+bash$ cd path/to/js-draw
+
+# Install dependencies
+bash$ yarn install
+
+# Run tests
+bash$ yarn test
+
+# Run tests/re-run tests when files change
+bash$ yarn test --watch
+
+# Build documentation
+bash$ yarn doc
+```
+
+## Running/building the example projects
+First, switch to the `docs` directory:
+```console
+bash$ cd path/to/js-draw/
+bash$ cd docs/
+```
+
+Next, `cd` to one of the example projects.
+
+### Main example project
+```bash
+bash$ cd example/
+
+# Install dependencies for the example project
+bash$ yarn install
+
+# Re-build when files change
+bash$ yarn watch
+```
+
+In a separate terminal, run a local web-server. Use the web-server to open the `example.html` file.
+```bash
+bash$ python3 -m http.server
+```
+
+### Collaborative editing project
+```bash
+bash$ cd example-collaborative/
+
+# Re-build when files change
+bash$ yarn watch
+```
+
+and in a separate terminal,
+```bash
+# Start the example project's server
+bash$ python3 server.py
+```
+
+# Notable files and directories
+> If this list is outdated, please open an issue.
+
+- [`src/localizations`](https://github.com/personalizedrefrigerator/js-draw/tree/main/src/localizations) and [`getLocalizationTable.ts`](https://github.com/personalizedrefrigerator/js-draw/blob/main/src/localizations/getLocalizationTable.ts).
+- [Stroke smoothing and geometric shape builders: `src/components/builders`](https://github.com/personalizedrefrigerator/js-draw/tree/main/src/components/builders)
+- [Main app entrypoint: `src/Editor.ts`](https://github.com/personalizedrefrigerator/js-draw/blob/main/src/Editor.ts)
+- [Default tools and sending events to them: `src/tools/ToolController.ts`](https://github.com/personalizedrefrigerator/js-draw/blob/main/src/tools/ToolController.ts)
+
+# Code style
+
+The coding style is, for the most part, enforced by a pre-commit hook.
+
+Because `js-draw` was originally created as a part of a pull request for the Joplin note-taking app,
+[it mostly follows Joplin's style guide](https://github.com/laurent22/joplin/blob/dev/readme/coding_style.md),
+with the exception that TypeDoc-style comments (`/** */`) are permitted for documentation.
+
+Note that `//`-style comments can also be used for documentation.