mirror of
https://github.com/tuono-labs/tuono
synced 2026-07-25 12:52:47 -07:00
Update getting started (#82)
* feat: update getting started doc * feat: update README
This commit is contained in:
@@ -13,10 +13,12 @@
|
|||||||
Tuono (Italian word for "thunder", pronounced /2 Oh No/).
|
Tuono (Italian word for "thunder", pronounced /2 Oh No/).
|
||||||
Why Tuono? Just a badass name.
|
Why Tuono? Just a badass name.
|
||||||
|
|
||||||
|
If you have experience with [Next.js](https://nextjs.org/) you will feel home here.
|
||||||
|
|
||||||
Some of its features are:
|
Some of its features are:
|
||||||
|
|
||||||
- 🟦 Native Typescript
|
- 🟦 Native Typescript
|
||||||
- 🌐 NextJs like Routing
|
- 🌐 Next.js like Routing
|
||||||
- 🍭 CSS/SCSS modules
|
- 🍭 CSS/SCSS modules
|
||||||
- 🧬 Server Side Rendering
|
- 🧬 Server Side Rendering
|
||||||
- 🔥 Hot Module Reload
|
- 🔥 Hot Module Reload
|
||||||
@@ -40,6 +42,13 @@ Tuono provides a collection of utilities to handle the server side code seamless
|
|||||||
Each server-side route is managed in a separate file alongside the React route. The routing is handled
|
Each server-side route is managed in a separate file alongside the React route. The routing is handled
|
||||||
by Tuono based on the files defined within the `./src/routes` directory.
|
by Tuono based on the files defined within the `./src/routes` directory.
|
||||||
|
|
||||||
|
**How is Tuono different from Next.js?**
|
||||||
|
|
||||||
|
The Tuono API tries to stick as much as possible to the Next.js one (or at least takes a huge inspiration
|
||||||
|
from it). The major difference is the backend system. While Next.js relies entirely on Node/Deno/Bun,
|
||||||
|
Tuono runs the server without any intermediary runtime. This enables impressive performance improvements
|
||||||
|
(check the benchmarks [here](https://github.com/Valerioageno/tuono/tree/main/benches)).
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
As already mentioned above, I strongly suggest you take a look at the
|
As already mentioned above, I strongly suggest you take a look at the
|
||||||
@@ -64,6 +73,7 @@ and to set the server project in `production` mode.
|
|||||||
Now to execute it just run `cargo run --release`.
|
Now to execute it just run `cargo run --release`.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Any help or suggestion will be appreciated and encouraged.
|
Any help or suggestion will be appreciated and encouraged.
|
||||||
Check the [✨Contributing](https://tuono.dev/documentation/contributing) page
|
Check the [✨Contributing](https://tuono.dev/documentation/contributing) page
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,11 @@ import SidebarLink from './sidebar-link'
|
|||||||
export default function Sidebar({ close }: { close: () => void }): JSX.Element {
|
export default function Sidebar({ close }: { close: () => void }): JSX.Element {
|
||||||
return (
|
return (
|
||||||
<AppShell.Navbar p="md">
|
<AppShell.Navbar p="md">
|
||||||
<SidebarLink href="/documentation" label="Overview" onClick={close} />
|
<SidebarLink
|
||||||
|
href="/documentation"
|
||||||
|
label="Getting started"
|
||||||
|
onClick={close}
|
||||||
|
/>
|
||||||
<SidebarLink
|
<SidebarLink
|
||||||
href="/documentation/installation"
|
href="/documentation/installation"
|
||||||
label="Installation"
|
label="Installation"
|
||||||
|
|||||||
@@ -12,39 +12,43 @@ import Breadcrumbs from '../../components/breadcrumbs'
|
|||||||
|
|
||||||
# Tuono
|
# Tuono
|
||||||
|
|
||||||
Tuono is a full-stack framework for building React applications using Rust as the
|
Tuono is a full-stack web framework for building React applications using Rust as the
|
||||||
backend.
|
backend with a strong focus on usability and performance.
|
||||||
|
|
||||||
Tuono (Italian word for "thunder", pronounced /2 Oh No/). Why Tuono? Just a badass name.
|
Tuono (Italian word for "thunder", pronounced /2 Oh No/). Why Tuono? Just a badass name.
|
||||||
|
|
||||||
## Introduction
|
If you have experience with [Next.js](https://nextjs.org/) you will feel home here.
|
||||||
|
|
||||||
NodeJs/Deno/Bun are the only runtimes that allow a React app to be full-stack right? (no)
|
|
||||||
|
|
||||||
Tuono is a full-stack React framework with the server side written in Rust.
|
|
||||||
Because of this, Tuono is extremely fast and, the requests are handled by a multithreaded Rust server.
|
|
||||||
React is still React - it is just superpowered.
|
|
||||||
|
|
||||||
Rust is a hard language, then writing server side code is hard as well, right? (no again)
|
|
||||||
|
|
||||||
Tuono provides a collection of utilities to handle the server side code seamlessly with
|
|
||||||
the React code. Each server side route is managed in a separate file alongside the React route.
|
|
||||||
The routing is handled by Tuono based on the files defined within the `./src/routes` directory.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
Some of its features include:
|
- 🟦 Native Typescript
|
||||||
|
- 🌐 Next.js like Routing
|
||||||
- 🟦 Full typescript support
|
- 🍭 CSS/SCSS modules
|
||||||
- 🌐 File system based routing
|
|
||||||
- 🔥 Hot Module Reload
|
|
||||||
- 🍭 SCSS/CSS modules
|
|
||||||
- 🧬 Server Side Rendering
|
- 🧬 Server Side Rendering
|
||||||
- 🧵 Multi-threaded backend
|
- 🔥 Hot Module Reload
|
||||||
- ⌨️ MDX support
|
|
||||||
- ⚙️ Build optimizations
|
|
||||||
- Custom APIs\*
|
|
||||||
- Image optimization\*
|
|
||||||
- Server streamed content\*
|
|
||||||
|
|
||||||
> \*development in progress
|
## Introduction
|
||||||
|
|
||||||
|
Tuono addresses the following two limits:
|
||||||
|
|
||||||
|
- Enable React server-side rendering projects without using JS runtimes (Node, Deno)
|
||||||
|
- Ease the web development using a typically hard language like Rust.
|
||||||
|
|
||||||
|
#### NodeJs/Deno/Bun are the only runtimes that allow a React app to be server-side rendered (SSR)? (no)
|
||||||
|
|
||||||
|
Tuono is the first full-stack React framework with the server side written in Rust (check the [ssr-rs](https://github.com/Valerioageno/ssr-rs) crate).
|
||||||
|
Because of this, Tuono is extremely fast, and the requests are handled by a multithreaded Rust server.
|
||||||
|
React is still React - it is just superpowered.
|
||||||
|
|
||||||
|
#### Rust is a hard language, then writing server side code is hard as well, right? (no again)
|
||||||
|
|
||||||
|
Tuono provides a collection of utilities to handle server-side code seamlessly with
|
||||||
|
the React code. Each server side route is managed in a separate file alongside the React route.
|
||||||
|
The routing is handled by Tuono based on the files defined within the `./src/routes` directory.
|
||||||
|
|
||||||
|
#### How is Tuono different from Next.js?
|
||||||
|
|
||||||
|
The Tuono API tries to stick as much as possible to the Next.js one (or at least takes a huge inspiration
|
||||||
|
from it). The major difference is the backend system. While Next.js relies entirely on Node/Deno/Bun,
|
||||||
|
Tuono runs the server without any intermediary runtime. This enables impressive performance improvements
|
||||||
|
(check the benchmarks [here](https://github.com/Valerioageno/tuono/tree/main/benches)).
|
||||||
|
|||||||
Reference in New Issue
Block a user