mirror of
https://github.com/tuono-labs/tuono
synced 2026-07-25 12:52:47 -07:00
Update README.md
This commit is contained in:
@@ -9,12 +9,21 @@
|
|||||||

|

|
||||||
|
|
||||||
|
|
||||||
**Tuono** is the react/rust fullstack framework.
|
**Tuono 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.
|
Why Tuono? Just a badass name.
|
||||||
|
|
||||||
> Check out the [tutorial](https://github.com/Valerioageno/tuono/blob/main/docs/tutorial.md) to get started.
|
Some of its features are:
|
||||||
|
|
||||||
|
- 🟦 Native Typescript
|
||||||
|
- 🌐 NextJs like Routing
|
||||||
|
- 🔥 Hot Module Reload
|
||||||
|
- 🍭 CSS/SCSS modules
|
||||||
|
- 🧬 Server Side Rendering
|
||||||
|
- 🧵 Multi thread backend
|
||||||
|
- ⌨️ MDX support
|
||||||
|
- ⚙️ Build optimizations
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
@@ -30,22 +39,6 @@ Tuono provides a collection of utilities to handle the server side code seamless
|
|||||||
Each server side route is managed with a separate file alongside the React route. The routing is handled
|
Each server side route is managed with 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.
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- 🟦 Typescript
|
|
||||||
- 🌐 Routing
|
|
||||||
- 🔥 Hot Module Reload
|
|
||||||
- 🍭 CSS modules
|
|
||||||
- 🧬 Server Side Rendering
|
|
||||||
- 🧵 Multi thread backend
|
|
||||||
- ⌨️ MDX support
|
|
||||||
- ⚙️ Build optimizations
|
|
||||||
- Custom APIs*
|
|
||||||
- Image optimization*
|
|
||||||
- Server streamed content*
|
|
||||||
|
|
||||||
> *Development in progress
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
As already mentioned above I strongly suggest you to take a look at the
|
As already mentioned above I strongly suggest you to take a look at the
|
||||||
@@ -69,30 +62,9 @@ and to set the server project in the `production` mode.
|
|||||||
|
|
||||||
Now to execute it just run `cargo run --release`.
|
Now to execute it just run `cargo run --release`.
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
- rust
|
|
||||||
- cargo
|
|
||||||
- node
|
|
||||||
- npm/pnpm/yarn*
|
|
||||||
|
|
||||||
> yarn [pnp](https://yarnpkg.com/features/pnp) is not supported yet
|
|
||||||
|
|
||||||
## Folder structure
|
|
||||||
|
|
||||||
```
|
|
||||||
├── package.json
|
|
||||||
├── public
|
|
||||||
├── src
|
|
||||||
│ ├── routes
|
|
||||||
│ └── styles
|
|
||||||
├── Cargo.toml
|
|
||||||
├── README.md
|
|
||||||
└── tsconfig.json
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user