rust-rescript-demo icon indicating copy to clipboard operation
rust-rescript-demo copied to clipboard

Rust + ReScript Demo

Demo app built with Rust and ReScript.

TOC

  • Tech Stack
  • Getting Started
    • Prerequisites
    • Installation
  • Developing
    • Windows Support
  • Not Implemented Yet

Tech Stack

API server:

Web client:

Getting Started

Prerequisites

Before proceeding, make sure you have:

Installation

Mostly everything in this project is managed via its own CLI.

To install the project's CLI, run in the root directory of this repository:

cargo run cli install

After that, you should have an rrd binary available in your shell.

To setup a local environment, run:

rrd setup

That's it. You are ready to roll.


If rrd command is not available in your shell, make sure your Rust toolchain is properly configured. Especially, check that Cargo's bin directory is in your PATH.

Developing

To start developing the app, run:

rrd develop

To explore what commands are available, run rrd help.

Windows Support

Windows should be supported. Though I'm totally unfamiliar with this operating system and some bits of the CLI most likely must be refined to fully support all features on Windows. Appreciate issues/pull requests if something doesn't work.

Not Implemented Yet

This project is quite raw and missing a bunch of pieces.

Some of them off the top of my head:

  • No tests
  • No i18n
  • No validations: neither server-side nor client-side
  • No caching mechanism in the web client

I'm sure there's a lot more. Feel free to create an issue if you are interested in something specific.