mirror of
https://github.com/tuono-labs/tuono
synced 2026-07-25 21:02:45 -07:00
Valerio Ageno
ea82d2b1df
* fix: documentation/index spelling * fix: documentation/development-setup spelling * fix: documentation/api-fetching spelling * fix: documentation/components spelling * fix: documentation/dynamic-routes spelling * feat: add correct tutorial link to README.md * chore: remove legacy folder * fix: formatting * fix: documentation/error-handling spelling * fix: documentation/seo spelling * fix: documentation/redirections spelling * fix: documentation/production spelling * fix: documentation/conclusion spelling * feat: update version to v0.10.4 * fix: redirections spelling * fix: API fetching spelling * feat: create CLI doc page * fix: correct CLI spelling * fix: update CLI output spelling
73 lines
2.7 KiB
Markdown
73 lines
2.7 KiB
Markdown
[Documentation](https://tuono.dev) | [Tutorial](https://tuono.dev/documentation/tutorial) |
|
|
[✨Contributing](https://tuono.dev/documentation/contributing)
|
|
|
|
# Tuono
|
|
|
|
<img align="right" src="https://raw.githubusercontent.com/Valerioageno/tuono/main/assets/logo.png" width="160px">
|
|
|
|
|
|
|
|
|
|
**Tuono is the fastest React framework out there**
|
|
|
|
Tuono (Italian word for "thunder", pronounced /2 Oh No/).
|
|
Why Tuono? Just a badass name.
|
|
|
|
Some of its features are:
|
|
|
|
- 🟦 Native Typescript
|
|
- 🌐 NextJs like Routing
|
|
- 🍭 CSS/SCSS modules
|
|
- 🧬 Server Side Rendering
|
|
- 🔥 Hot Module Reload
|
|
|
|
## 📖 Documentation
|
|
|
|
The [documentation](https://tuono.dev/documentation) is available on
|
|
[tuono.dev](https://tuono.dev/).
|
|
|
|
## Introduction
|
|
|
|
**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.
|
|
|
|
## 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.
|
|
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
|
|
[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`
|
|
|
|
Finally, when the project is ready to be deployed, just run `tuono build` to create the final React assets
|
|
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
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License.
|