2024-10-17 19:00:23 +02:00
|
|
|
[Documentation](https://tuono.dev) | [Tutorial](https://tuono.dev/documentation/tutorial) |
|
2024-11-19 16:43:58 +01:00
|
|
|
[Discord](https://discord.com/invite/khQzPa654B) | [✨Contributing](https://tuono.dev/documentation/contributing)
|
2024-05-18 11:50:56 +02:00
|
|
|
|
2024-08-15 20:34:58 +02:00
|
|
|
# Tuono
|
|
|
|
|
|
2024-11-30 14:16:10 +01:00
|
|
|
<img align="right" src="https://raw.githubusercontent.com/tuono-labs/tuono/main/assets/logo.png" width="160px">
|
2024-08-15 20:34:58 +02:00
|
|
|
|
2024-11-30 14:16:10 +01:00
|
|
|

|
|
|
|
|

|
2024-08-15 20:34:58 +02:00
|
|
|
|
2024-11-20 18:57:43 +01:00
|
|
|
**Tuono is a full-stack web framework for building React applications using Rust as the backend with
|
|
|
|
|
a strong focus on usability and performance.**
|
2024-05-02 20:49:46 +02:00
|
|
|
|
2024-11-10 10:44:36 +01:00
|
|
|
Tuono (Italian word for "thunder", pronounced /2 Oh No/).
|
2024-05-02 20:49:46 +02:00
|
|
|
Why Tuono? Just a badass name.
|
2024-04-27 10:10:50 +02:00
|
|
|
|
2024-11-10 10:44:36 +01:00
|
|
|
If you have experience with [Next.js](https://nextjs.org/) you will feel home here.
|
2024-08-20 14:30:46 +02:00
|
|
|
|
2024-11-10 10:44:36 +01:00
|
|
|
Some of its features are:
|
|
|
|
|
|
|
|
|
|
- 🟦 Native Typescript
|
|
|
|
|
- 🌐 Next.js like Routing
|
|
|
|
|
- 🍭 CSS/SCSS modules
|
|
|
|
|
- 🧬 Server Side Rendering
|
|
|
|
|
- 🔥 Hot Module Reload
|
2024-08-20 14:34:37 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
## Documentation
|
2024-08-20 14:34:37 +02:00
|
|
|
|
2024-12-16 13:57:25 +01:00
|
|
|
The [documentation](https://tuono.dev/) is available on
|
2024-08-20 14:34:37 +02:00
|
|
|
[tuono.dev](https://tuono.dev/).
|
2024-06-06 20:54:09 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
## Installation
|
2024-06-05 21:17:26 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
Available on MacOS, Linux and Windows.
|
2024-06-05 21:17:26 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
```sh
|
|
|
|
|
cargo install tuono
|
|
|
|
|
```
|
2024-11-10 10:44:36 +01:00
|
|
|
|
2024-06-21 19:33:01 +02:00
|
|
|
## Getting started
|
2024-06-05 21:17:26 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
Create a new project with:
|
2024-07-12 11:01:55 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
```sh
|
|
|
|
|
tuono new [PROJECT_NAME]
|
|
|
|
|
```
|
2024-05-18 20:45:35 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
> You can optionally pass the --template (or -t) flag to directly start from a [template](https://github.com/tuono-labs/tuono/tree/main/examples)
|
2024-05-18 11:50:56 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
Now just install the dependencies with you favourite JS package manager (i.e. `npm install`) and start the development environment
|
2024-06-23 20:15:33 +02:00
|
|
|
|
2025-01-22 19:07:30 +01:00
|
|
|
```sh
|
|
|
|
|
tuono dev
|
|
|
|
|
```
|
2024-06-21 19:33:01 +02:00
|
|
|
|
2024-06-17 13:45:21 +02:00
|
|
|
## Contributing
|
2024-11-10 10:44:36 +01:00
|
|
|
|
2024-06-23 20:15:33 +02:00
|
|
|
Any help or suggestion will be appreciated and encouraged.
|
2024-08-20 14:30:46 +02:00
|
|
|
Check the [✨Contributing](https://tuono.dev/documentation/contributing) page
|
2024-06-17 13:45:21 +02:00
|
|
|
|
2024-06-05 21:17:26 +02:00
|
|
|
## License
|
2024-05-11 15:08:49 +02:00
|
|
|
|
2024-06-05 21:17:26 +02:00
|
|
|
This project is licensed under the MIT License.
|