Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dimchikkk/velo

App for brainstorming & sharing ideas 🦀 Learning Project
https://github.com/dimchikkk/velo

bevy bevy-ui rust webgpu

Last synced: 1 day ago
JSON representation

App for brainstorming & sharing ideas 🦀 Learning Project

Awesome Lists containing this project

README 

        
# Velo 🚵‍♀️🚵

![Rust](https://img.shields.io/badge/Rust-lang-000000.svg?style=flat&logo=rust)[![codecov](https://codecov.io/gh/StaffEngineer/velo/branch/main/graph/badge.svg?token=QGEKLM6ZDF)](https://codecov.io/gh/StaffEngineer/velo)



![velo](./velo.gif)

![alt text](velo.png "Velo")



## Demo



This app is primarily designed for native desktop platforms, and its

WebAssembly (wasm) target has a limited feature set. wasm target is best

suited for quick document sharing, currently, only WebGPU backend enabled for the demo:



  [](https://staffengineer.github.io/velo?document=https://gist.githubusercontent.com/StaffEngineer/bf7d94759abbd7aa722330e5fe4f0bd5/raw/e817be0ba700e94be472d435638d762b9deadf33/velo.json)



## What\'s implemented:

-   support rectangle/circle/paperlike notes

-   add/remove note

-   note resizing

-   note repositioning

-   wrapped text inside notes

-   paste screenshot from clipboard [native target only 🖥️] 

-   connect notes with arrows

-   make app snapshot in memory and load from it (MacOs: Command + s\[l\])

-   save app state to database and load from it

-   change background color of notes

-   move note to front/back

-   positioning text inside note

-   multiple documents/tabs support

-   load app state from url

-   ability to create sharable url of the document using \"Share

    Document\" button (**.velo.toml** should be created in user's home

    directory containing GitHub access token with \"gist\" scope) [native target only 🖥️]:



   ```toml

   github_access_token = ""

   ```



- initial markdown support

  - italic/bold text style

  - links

  - syntax highlighting

  - headings (proper headings support was temporarily removed)

  - inline code

  - ordered/unordered lists

- particles effect [native target only 🖥️]

- filter documents by text in notes (fuzzy search) [native target only 🖥️]

- highlight notes containing searched text [native target only 🖥️]

- ligature/emoji rendering support [emoji native target only 🖥️]

- dark/light theme support (app restart is required for now)

- infinite canvas with zooming (right click to move camera, mouse wheel to zoom)

- undo/redo for text editing [native target only 🖥️]

- drawing mode (click on pencil icon to enable it)

- draw line, arrow, rhombus or rectangle by choosing 2 points

- hide/show children notes for selected note

- navigation to random note



## Installation



[Archives of precompiled binaries for *velo* are available for Windows, macOS

and Linux.](https://github.com/StaffEngineer/velo/releases/latest)



### Compiling from Source



If you want to compile from source you can use 

```sh

cargo install --path .

```



**ATTENTION**

If you have set your cargo target directory in `.cargo/config.toml` you must provide the fullpath to the assets directory like this

```sh

BEVY_ASSET_PATH=$(realpath assets) cargo install --path .

```



## Run



Native:



```sh

cargo r --release

```



Wasm:



```sh

cargo install wasm-server-runner

RUSTFLAGS=--cfg=web_sys_unstable_apis cargo r --release --target wasm32-unknown-unknown

```



To create app bundle with icon (tested only on MacOS):



```sh

cargo install cargo-bundle

cargo bundle

```



## Pre-commit actions



```sh

cargo fmt

cargo clippy -- -A clippy::type_complexity -A clippy::too_many_arguments

```



## Basic usage



- click on rectangle icon to create rectangle note

- double-click to select note

- start typing to add text to selected note

- resize note by dragging its corners

- click on canvas to deselect note

- move note by dragging it (only unselected note can be dragged to allow mouse text selection for selected note)

- click on little arrow connector icon to connect notes, arrow connector icons are placed on each side of note

- for native target there is search box that allows to filter documents by text in notes (fuzzy search)

- for wasm target there is url query parameter `?document=` to load document from url

- click save icon to save document to database on native platform or to localStorage on wasm target

- click on drawing pencil to enable drawing mode



## Troubleshooting



If the application fails to start, you can try resolving the issue by removing velo data folder. This problem may occur due to changes in the data schema between different versions of the application.



- MacOS: `/Users//Library/Application Support/velo`

- Windows: `C:\Users\\AppData\Roaming\velo`

- Linux: `/home//.config/velo`

- wasm: `localStorage.clear()`



## License

All code in this repository dual-licensed under either:



MIT License or http://opensource.org/licenses/MIT

Apache License, Version 2.0 or http://www.apache.org/licenses/LICENSE-2.0

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.



## Contributing

Contributions are always welcome! Please adhere to this project\'s code

of conduct.



❤️