这是indexloc提供的服务,不要输入任何密码
Skip to content

Update getting started #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,18 @@

**Tuono is the fastest React framework out there**

Tuono (Italian word for "thunder", pronounced /2 Oh No/).
Tuono (Italian word for "thunder", pronounced /2 Oh No/).
Why Tuono? Just a badass name.

Some of its features are:
If you have experience with [Next.js](https://nextjs.org/) you will feel home here.

- 🟦 Native Typescript
- 🌐 NextJs like Routing
- 🍭 CSS/SCSS modules
- 🧬 Server Side Rendering
- 🔥 Hot Module Reload
Some of its features are:

- 🟦 Native Typescript
- 🌐 Next.js like Routing
- 🍭 CSS/SCSS modules
- 🧬 Server Side Rendering
- 🔥 Hot Module Reload

## 📖 Documentation

Expand All @@ -30,7 +32,7 @@ The [documentation](https://tuono.dev/documentation) is available on

**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.
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.

Expand All @@ -40,20 +42,27 @@ 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
by Tuono based on the files defined within the `./src/routes` directory.

**How is Tuono different from Next.js?**
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS


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,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Demo, Deny, Den, Reno, Deng, Dino, Leno, Dens, Dent, Dena, Keno, Deon, Zeno
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

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

As already mentioned above, I strongly suggest you take a look at the
[tutorial](https://github.com/Valerioageno/tuono/blob/main/docs/tutorial.md).

Tuono is the CLI that provides all the needed commands to handle the full-stack project.
Tuono is the CLI that provides all the needed commands to handle the full-stack project.
To download it is required [cargo](https://doc.rust-lang.org/cargo/), which is the [rust](https://www.rust-lang.org/)
package manager.

Then run `cargo install tuono`.

To list all the available commands, run `tuono -h`

To create a new project, run `tuono new [NAME]` (optionally, you can pass the `--template` (or `-t`) flag - check the
To create a new project, run `tuono new [NAME]` (optionally, you can pass the `--template` (or `-t`) flag - check the
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: too, turn, turns, Tony, ton, tone, tons, tune, mono, turbo, Juno, tuna, Togo, Toni, guano, Cuomo, Toto, thong, Tonto, dunno, tong, Tojo, USNO, tunny, tony, tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, muon, muons, tron, trons, tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

[examples](https://github.com/Valerioageno/tuono/tree/main/examples) folder).

Then, to run the local development environment, run it inside the project folder `tuono dev`
Expand All @@ -64,6 +73,7 @@ and to set the server project in `production` mode.
Now to execute it just run `cargo run --release`.

## Contributing

Any help or suggestion will be appreciated and encouraged.
Check the [✨Contributing](https://tuono.dev/documentation/contributing) page

Expand Down
6 changes: 5 additions & 1 deletion apps/documentation/src/components/sidebar/sidebar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ import SidebarLink from './sidebar-link'
export default function Sidebar({ close }: { close: () => void }): JSX.Element {
return (
<AppShell.Navbar p="md">
<SidebarLink href="/documentation" label="Overview" onClick={close} />
<SidebarLink
href="/documentation"
label="Getting started"
onClick={close}
/>
<SidebarLink
href="/documentation/installation"
label="Installation"
Expand Down
50 changes: 27 additions & 23 deletions apps/documentation/src/routes/documentation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,43 @@ import Breadcrumbs from '../../components/breadcrumbs'

# Tuono

Tuono is a full-stack framework for building React applications using Rust as the
backend.
Tuono is a full-stack web framework for building React applications using Rust as the
backend with a strong focus on usability and performance.

Tuono (Italian word for "thunder", pronounced /2 Oh No/). Why Tuono? Just a badass name.

If you have experience with [Next.js](https://nextjs.org/) you will feel home here.

## Features

- 🟦 Native Typescript
- 🌐 Next.js like Routing
- 🍭 CSS/SCSS modules
- 🧬 Server Side Rendering
- 🔥 Hot Module Reload

## Introduction

NodeJs/Deno/Bun are the only runtimes that allow a React app to be full-stack right? (no)
Tuono addresses the following two limits:

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.
- Enable React server-side rendering projects without using JS runtimes (Node, Deno)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Demo, Deny, Den, Reno, Deng, Dino, Leno, Dens, Dent, Dena, Keno, Deon, Zeno
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

- Ease the web development using a typically hard language like Rust.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
The official spelling of this programming framework is “Node.js”. (NODE_JS[3])
Suggestions: Node.js
Rule: https://community.languagetool.org/rule/show/NODE_JS?lang=en-US&subId=3
Category: COMPOUNDING


#### NodeJs/Deno/Bun are the only runtimes that allow a React app to be server-side rendered (SSR)? (no)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Demo, Deny, Den, Reno, Deng, Dino, Leno, Dens, Dent, Dena, Keno, Deon, Zeno
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS


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).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: SSRIs, SSRS
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

Because of this, Tuono is extremely fast, and the requests are handled by a multithreaded Rust server.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

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)
#### Rust is a hard language, then writing server side code is hard as well, right? (no again)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS


Tuono provides a collection of utilities to handle the server side code seamlessly with
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.

## Features

Some of its features include:
#### How is Tuono different from Next.js?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS


- 🟦 Full typescript support
- 🌐 File system based routing
- 🔥 Hot Module Reload
- 🍭 SCSS/CSS modules
- 🧬 Server Side Rendering
- 🧵 Multi-threaded backend
- ⌨️ MDX support
- ⚙️ Build optimizations
- Custom APIs\*
- Image optimization\*
- Server streamed content\*

> \*development in progress
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,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Demo, Deny, Den, Reno, Deng, Dino, Leno, Dens, Dent, Dena, Keno, Deon, Zeno
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Suggestions: Too, Turn, Turns, Tony, Ton, Tone, Tons, Tune, Mono, Turbo, Juno, Tuna, Togo, Toni, Guano, Cuomo, Toto, Thong, Tonto, Dunno, Tong, Tojo, USNO, Tunny, Tuns, Bono, Ono, TNO, TUN, Taíno, Truong, UNO, Muon, Muons, Tron, Trons, Tun, Totò
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

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)).