Tuono Framework

Tuono is a full-stack web framework for building React applications that uses Rust for the backend. It is designed to feel familiar to Next.js users and provides the following core features:

• Native Typescript: Full support for TypeScript.
• Next.js like Routing: File-system based routing similar to Next.js.
• CSS/SCSS modules: Support for modular styling.
• Server Side Rendering (SSR): Built-in support for rendering on the server.
• Hot Module Reload (HMR): Fast development feedback loop.

To start a new Tuono project pre-configured with MDX support, use the tuono new command with the with-mdx template. This will scaffold a starter project that includes MDX integration out of the box.

tuono new tuono-with-mdx --template with-mdx

Tuono allows you to scaffold projects using specific starter templates. Use the --template flag followed by the name of the template folder (found in the examples/ directory) to apply that specific configuration to your new project.

tuono new [NAME] --template [TEMPLATE]

To create a new project with the standard Tuono base configuration, use the tuono new command followed by your desired project name.

tuono new [NAME]

You can scaffold a new Tuono project pre-configured with Tailwind CSS using the tuono new command and the with-tailwind template. This is the fastest way to start a project that includes the necessary Tailwind CSS setup.

tuono new tuono-with-tailwind --template with-tailwind

After creating your project and installing dependencies (e.g., via npm install), run the following command to start the development server with Hot Module Reload (HMR) enabled:

tuono dev

Install the Tuono command-line interface globally using cargo. This tool is available on MacOS, Linux, and Windows.

cargo install tuono

You can quickly scaffold a new project using the tuono-tutorial template by running the tuono new command with the -t (template) flag. This is useful for exploring the project structure and learning how Tuono is configured in a real-world scenario.

tuono new -t tuono-tutorial

To start a new project, use the tuono new command. You can optionally specify a template using the --template or -t flag to scaffold your project from one of the available examples.

tuono new [PROJECT_NAME]

Using a template:

tuono new [PROJECT_NAME] --template [TEMPLATE_NAME]

Tuono identifies API routes by checking if the path starts with /api/. For these routes, it scans the corresponding source file in src/routes{path}.rs for the tuono_lib::api(...) macro to extract supported HTTP methods.

If a route is identified as an API route, it is excluded from Static Site Generation (SSG) processes, as API endpoints typically return data rather than HTML pages.