neo-space

"In the future, frontends will be written in C, C++, and Rust. Backends will be written in Typescript." - You if contribute to this project

A Rust based open source infinite canvas project that will attempt to have many of the features of figma, and certainly more features than freeform. This project will work both as WebAssembly compiled from Rust and as a standalone native Rust application. Write and add any plugin you want. Download, embed, share the code as much as you want. No corporate middle men.

Eventually there will be a SDK developed allowing for the easy integration of the canvas and various drawing features.

Prerequisites

Node.js (v14 or later)
Rust (latest stable version)
wasm-pack

Compiling and Running the Full Project

Clone the repository:

git clone https://github.com/yourusername/infinite-grid-drawing-app.git
cd infinite-grid-drawing-app

Install dependencies:
```
npm install
```
Build the project (this compiles Rust to WebAssembly and builds the frontend):
```
npm run build
```
Start the development server:
```
npm start
```
Open your browser and navigate to http://localhost:8080 (or the port specified in the console output).

Compiling and Testing the Rust Portion Separately

If you want to work on or test the Rust code independently:

Navigate to the Rust project directory:
```
cd rust-drawing-engine
```
Run tests:
```
cargo test
```
Build the Rust project (without creating WebAssembly):
```
cargo build
```
To compile to WebAssembly without building the frontend:
```
wasm-pack build --target web
```
This will create a pkg directory in rust-drawing-engine with the WebAssembly output.

Project Structure

frontend/: Contains the JavaScript frontend code
rust-drawing-engine/: Contains the Rust backend code
Cargo.toml: Rust workspace configuration
package.json: Node.js project configuration

Development

To modify the frontend, edit files in the frontend/ directory.
To modify the Rust backend, edit files in the rust-drawing-engine/src/ directory.
After making changes to Rust code, run npm run build to recompile and update the WebAssembly.

helpful git commands for contributing

fork the original repo, download it, and work off a new branch

git checkout -b name-that-implies-your-change

verify that you are tracking the remote

git remote -v

you might be tracking your own remote, add neo-space/neo-space as a remote

git remote add upstream https://github.com/neo-space/neo-space.git

check your origin and upstream, you should see something like this. origin is your fork and neo-space is the original

origin  git@github.com:vanitysemptiness/neo-space.git (fetch)
origin  git@github.com:vanitysemptiness/neo-space.git (push)
upstream        https://github.com/neo-space/neo-space.git (fetch)
upstream        https://github.com/neo-space/neo-space.git (push)

fetch latest changes from upstream repository

git fetch upstream

change to your main branch, ditch your changes in main (which should be none as you use branches), and reset to upstream/main

git checkout main
git reset --hard upstream/main

push your updated main to your forks main

git push origin main --force

branching, making changes, and pushing them to your fork (origin)

git checkout -b my-new-feature
# Make your changes, commit them
git push origin my-new-feature

Once thats there, raise the PR against neo-space/neo-space on github

Try your best to follow conventional commits https://www.conventionalcommits.org/en/v1.0.0/ I can't promise that I will only ever be conventional, nor do I promise that I will only accept other's PR's if they are conventional, but why not try?