Pulsar

This is a desktop app using the following technologies.

Tools:

• Desktop framework: Tauri
• Bundler: Vite
• Package manager: yarn

Front-End:

• UI framework: Preact
• Language: TypeScript
• State manager: Effector
• Styles: CSS modules & Sass
• UI library: Headless UI
• Architecture: Feature Sliced Design
• Database: WatermelonDB

Back-End:

• Language: Rust

Requirements

See Tauri's prerequisites for platform-specific requirements.

Corepack

Project is using yarn v4. You don't need to install anything but you do need to enable corepack. Before running any other command run:

corepack enable

Corepack is a nodejs module that enables to use other package managers (pnpm, yarn) without the need to install them

Start the app

git clone https://github.com/nchapman/pulsar
cd pulsar
git submodule update --init --recursive
yarn
yarn start

Testing

yarn test:frontend

For backend tests you need to have git-lfs installed (brew install git-lfs). After you have cloned the repo do:

git lfs install
git lfs pull

It will download a small llm that is required to run the tests.

Afterwards you can do

yarn test:backend

Commits

Please, use Conventional Commits for naming your commits

type(where): action description

example:

feat(chat): add initial screen

See more examples in commits history.

Recommended IDE Setup

• VS Code + Tauri + rust-analyzer