Files
tuono/README.md
T

77 lines
1.7 KiB
Markdown
Raw Normal View History

2024-05-12 21:52:04 +02:00
<p align="center">
2024-06-03 20:59:39 +02:00
<img src="https://raw.githubusercontent.com/Valerioageno/tuono/main/assets/logo.png" width="200px">
2024-05-12 21:52:04 +02:00
</p>
<h1 align="center">Tuono<br>The react/rust fullstack framework</h1>
2024-05-18 11:50:56 +02:00
<p align="center">
⚠️ This project is under heavy development. API might drastically change ⚠️
</p>
2024-05-02 20:49:46 +02:00
Tuono (Italian word for "thunder", pronounced /2 Oh No/).
Why Tuono? Just a badass name.
2024-04-27 10:10:50 +02:00
2024-06-06 20:54:09 +02:00
> If you want to see how this project actually works check the [tutorial](https://github.com/Valerioageno/tuono/blob/main/docs/tutorial.md) page.
2024-06-05 21:17:26 +02:00
## Introduction
2024-06-06 08:34:59 +02:00
NodeJs/Deno/Bun are the only tools that make a React app fullstack right? (no)
2024-06-05 21:17:26 +02:00
Tuono wants to prove that it's possible creating fully fledged react applications without the need to host them on a JS runtime server leveraging the best of the two worlds:
2024-06-06 08:34:59 +02:00
super powered server and amazing development experience.
2024-06-05 21:17:26 +02:00
## Requirements
- rust
- cargo
- node
- pnpm (other package managers support will be added soon)
2024-05-18 11:50:56 +02:00
## Installation
```
cargo install tuono
```
2024-05-18 20:45:35 +02:00
## Create a new project
```
2024-06-05 21:17:26 +02:00
tuono new [NAME]
2024-05-18 20:45:35 +02:00
```
2024-05-18 11:50:56 +02:00
## Development
```
tuono dev
```
2024-04-27 10:10:50 +02:00
## Features
2024-06-05 21:17:26 +02:00
- [x] FS routing
- [x] Hot Module Reload
2024-06-06 18:57:47 +02:00
- [x] CSS modules
2024-06-05 21:17:26 +02:00
- [x] Rust based server side rendering
- [x] Multi thread backend
- [x] Development environment
- [ ] Create custom APIs
- [ ] Image optimization
- [ ] Build optimization
2024-06-07 12:22:20 +02:00
- [ ] Server streamed content
2024-06-05 21:17:26 +02:00
> 💡 Any suggestion or improvement is strongly appreciated
2024-04-27 10:10:50 +02:00
## Folder structure
```
2024-06-12 13:42:02 +02:00
├──  package.json
├──  public
├──  src
│ ├──  routes
│ └──  styles
├──  Cargo.toml
├──  README.md
└──  tsconfig.json
2024-04-27 10:10:50 +02:00
```
2024-05-11 15:08:49 +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.