diff --git a/.github/graphics/nodes.svg b/.github/graphics/nodes.svg new file mode 100644 index 0000000..5091291 --- /dev/null +++ b/.github/graphics/nodes.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md new file mode 100644 index 0000000..c0602a3 --- /dev/null +++ b/ARCHITECTURE.md @@ -0,0 +1,19 @@ +# Nodarium Architecture + +The basic idea of nodarium is to use the advantages of WebAssembly to create a performant, secure and extandable visual programming language. + +## What is a node? + +```typescript +type Node = { + id: string, + outputs: string[], + inputs: { + [key:string]: NodeInput + } +} +``` + +## How are the nodes executed? + +## How are the nodes stored? diff --git a/DEVELOPING_NODES.md b/DEVELOPING_NODES.md new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 30cca77..ec97e17 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,50 @@ Nodarium -Info tbd. +
+ +

Nodarium

 + +

+ Nodarium is a WebAssembly based visual programming language. +

+ + + +
+ +# Table of contents + +- [Architecture](./ARCHITECTURE.md) +- [Developing](#developing) +- [Roadmap](#roadmap) + +# Developing + +### Install prerequisites: + +- [Node.js](https://nodejs.org/en/download) +- [pnpm](https://pnpm.io/installation) +- [rust](https://www.rust-lang.org/tools/install) + +### Install dependencies + +```bash +pnpm i +``` + +### Build the Nodes + +```bash +pnpm build:nodes +``` + +### Start the dev server + +```bash +cd app +pnpm dev +``` + +### [Now you can create your first node 🤓](./DEVELOPING_NODES.md) + +# Roadmap