fork/Graphite
1
0
Fork 0
mirror of https://github.com/GraphiteEditor/Graphite.git synced 2026-09-15 14:18:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove CLI client stub

Browse Source
This commit is contained in:
Keavon Chambers
2021-07-15 03:44:57 -07:00
parent 7785ed2b1d
commit 67131a23fd
7 changed files with 8 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -52,29 +52,21 @@ Development is broken into monthly sprints culminating in a presentation at the
## Running the code
The project is split between clients and core libraries (which use the clients). Currently the only important client is the web frontend (`/client/web`). There's also a CLI client (`/client/cli`) that may be useful for testing. The only core library so far is the Editor Core Library (`/core/editor`). The web client's Vue code lives in `/client/web/src` and a Rust wrapper for the Editor Core Library (which exposes functions to JavaScript through bindings generated by wasm-bindgen) lives in `/client/web/wasm`.
The project is split between clients and core libraries (which are used by the clients). Currently the only client is the web frontend (`/client/web`). The web client's Vue code lives in `/client/web/src` and a Rust translation layer for the editor core library lives in `/client/web/wasm`.
A good starting point for learning about the code structure and architecture is reading the [documentation](docs/index.md).
### Web client
This is the primary means of running and developing the project. You may need to download and install a recent version of [Node.js](https://nodejs.org/) and [Rust](https://www.rust-lang.org/) (on Windows, this requires the MSVC toolchain properly configured with the Visual Studio Build Tools installed on your machine including the "Desktop development with C++" workload).
This is the primary means of running and developing the project. You may need to download and install a recent version of [Node.js](https://nodejs.org/) and [Rust](https://www.rust-lang.org/) (on Windows, this requires the MSVC toolchain properly configured with the Visual Studio Build Tools installed on your machine including the "Desktop development with C++" workload). Ensure you have the latest stable version of Rust if there are issues building.
```
npm run serve
```
After editing some Rust and TypeScript code, you may need to manually restart the developments server because this is not properly watching all files right now. (Please submit a PR to help fix this!)
The server automatically watches for changes to Vue files and rebuilds them. However core Rust and TypeScript file changes require a manual restart of the development server. (Please submit a PR to help it watch the `.ts` files!)
You can also use `npm run lint` as well as `npm run build` (the static files will end up in `/client/web/dist`).
### CLI client
This may be useful for testing at some point in the future.
```
cargo run
```
You can also use `npm run lint` and `npm run lint-no-fix` to solve web formatting and `cargo fmt` for Rust formatting. Also `npm run build` writes static files to `/client/web/dist` instead of serving them from memory.
### Editor core library