diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 3be0d67b..ce8395a0 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,7 +2,7 @@ ## Our Pledge -We as members, contributors, and leaders pledge to make participation in our +We, as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, @@ -22,18 +22,18 @@ community include: * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the +* Focusing on what is best, not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or - advances of any kind + Advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +* Other conduct that could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -45,13 +45,13 @@ or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation +not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. +An individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c89ac0d3..3f7b7876 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,12 +2,12 @@ ![](https://github.com/Valerioageno/tuono/actions/workflows/typescript.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -# How to contribute to Tuono +# How to Contribute to Tuono ## Contributions Any feature contribution or suggestion is strongly appreciated. -Since the current project size there isn't yet a defined way to start a discussion. Consider to [open a new issue](https://github.com/Valerioageno/tuono/issues/new) -or to reach me using my email address [valerioageno@yahoo.it](mailto:valerioageno@ahoo.it). I'm also available on twitter (X) DMs @valerioageno. +Since the current project size, there isn't yet a defined way to start a discussion. Consider [opening a new issue](https://github.com/Valerioageno/tuono/issues/new) +or to reach me using my email address, [valerioageno@yahoo.it](mailto:valerioageno@ahoo.it). I'm also available on Twitter (X); DM @valerioageno. ## Bugs @@ -17,5 +17,5 @@ or to reach me using my email address [valerioageno@yahoo.it](mailto:valerioagen **Did you write a patch that fixes a bug?** - Open a new GitHub pull request with the patch. -- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. +- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number, if applicable. - The pull requests must pass all the CI pipelines diff --git a/README.md b/README.md index 611b5cb8..c43d0747 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ ![](https://github.com/Valerioageno/tuono/actions/workflows/rust.yml/badge.svg) ![](https://github.com/Valerioageno/tuono/actions/workflows/typescript.yml/badge.svg) -Adding file to commit history for testing - **Tuono is the fastest React framework out there** Tuono (Italian word for "thunder", pronounced /2 Oh No/). @@ -30,38 +28,38 @@ The [documentation](https://tuono.dev/documentation) is available on ## Introduction -**NodeJs/Deno/Bun are the only runtimes that allow a React app to be fullstack right? (no)** +**NodeJs/Deno/Bun are the only runtimes that allow a React app to be full-stack right? (no)** -Tuono is a fullstack React framework with the server side written in Rust. -Because of this Tuono is extremely fast and the requests are handled by multithreaded Rust server. +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 an 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)** Tuono provides a collection of utilities to handle the server side code seamlessly with the React code. -Each server side route is managed with a separate file alongside the React route. The routing is handled +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 to take a look at the +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 fullstack project. -To download it is required [cargo](https://doc.rust-lang.org/cargo/) which is the [rust](https://www.rust-lang.org/) +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 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 [examples](https://github.com/Valerioageno/tuono/tree/main/examples) folder). -Then to run the local development environment run inside the project folder `tuono dev` +Then, to run the local development environment, run it inside the project folder `tuono dev` -Finally when the project will be ready to be deployed just run `tuono build` to create the final React assets -and to set the server project in the `production` mode. +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`. diff --git a/apps/documentation/src/components/hero/hero.tsx b/apps/documentation/src/components/hero/hero.tsx index 6ff60759..bf2054f5 100644 --- a/apps/documentation/src/components/hero/hero.tsx +++ b/apps/documentation/src/components/hero/hero.tsx @@ -15,12 +15,12 @@ export default function Hero(): JSX.Element { return (
- The react/rust fullstack framework + The React/Rust full-stack framework
- The technologies we love seamessly working together to unleash the - highest web performance ever met on react + The technologies we love seamlessly working together to unleash the + highest web performance ever met on React
diff --git a/apps/documentation/src/routes/documentation/contributing.mdx b/apps/documentation/src/routes/documentation/contributing.mdx index 5daaa1bf..2058af14 100644 --- a/apps/documentation/src/routes/documentation/contributing.mdx +++ b/apps/documentation/src/routes/documentation/contributing.mdx @@ -14,24 +14,24 @@ import Breadcrumbs, { Element } from '../../components/breadcrumbs' ## TL;DR -The project is massive - if you like it do consider to contribute! +The project is massive - if you like it, do consider contributing! ## Getting started -The `tuono` project can mostly be split by the following sub-domains: +The `tuono` project can mostly be split into the following subdomains: - The CLI -- The rust backend -- The react frontend +- The Rust backend +- The React frontend - The documentation website (which is written with tuono 🚀) -To check what are the knowledge requirement for each domain check the +To check what the knowledge requirements are for each domain, check the [requirements](#requirements) section below. -Currently I'm keeping a private dashboard to prioritize new features and bug fixes but if you -want to propose something please open a new issue on github or reach me using +Currently, I'm keeping a private dashboard to prioritize new features and bug fixes, but if you +want to propose something, please open a new issue on Github or reach out to me using my email address [valerioageno@yahoo.it](mailto:valerioageno@yahoo.it). I'm also available -on twitter (X) DMs `@valerioageno`, [linkedin](https://www.linkedin.com/in/valerioageno) +on Twitter (X) DMs `@valerioageno`, [Linkedin](https://www.linkedin.com/in/valerioageno) and discord `@__v__v__`. ## Requirements @@ -39,10 +39,10 @@ and discord `@__v__v__`. It's not strictly required to know both React (& typescript) and Rust (even though it would be a great nice to have). -Without taking into account specific cases we can mostly split the domain requirements by: +Without taking into account specific cases, we can mostly split the domain requirements by: -- The `CLI` needs Rust knowledge (even though a couple of scenario might need also Typescript) +- The `CLI` needs Rust knowledge (even though a couple of scenarios might also need Typescript) - The Backend needs just `Rust` - The Frontend needs just `React` & `Typescript` -- The documentation website needs just `React` & `Typescript` (or even less since most of the +- The documentation website needs just `React` & `Typescript` (or even less, since most of the code is markdown). diff --git a/apps/documentation/src/routes/documentation/getting-started.mdx b/apps/documentation/src/routes/documentation/getting-started.mdx index 3dad689d..692693a1 100644 --- a/apps/documentation/src/routes/documentation/getting-started.mdx +++ b/apps/documentation/src/routes/documentation/getting-started.mdx @@ -14,17 +14,17 @@ import Breadcrumbs, { Element } from '../../components/breadcrumbs' ## The CLI -Tuono is the CLI that provides all the needed commands to handle the fullstack project. +Tuono is the CLI that provides all the needed commands to handle the full-stack project. > ☝️ Check the [installation](/documentation/installation) page if you haven't installed the > `tuono` CLI yet. -To list all the available commands run `tuono -h`. +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 folder). +To create a new project, run `tuono new [NAME]` (optionally you can pass the --template (or -t) flag - check the examples' folder). Then to run the local development environment run inside the project folder `tuono dev` -Finally when the project will be ready to be deployed just run `tuono build` to create the final React assets and to set the server project in the production mode. +Finally, when the project will be ready to be deployed just run `tuono build` to create the final React assets 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`. diff --git a/apps/documentation/src/routes/documentation/index.mdx b/apps/documentation/src/routes/documentation/index.mdx index 8a6631ef..2b830df5 100644 --- a/apps/documentation/src/routes/documentation/index.mdx +++ b/apps/documentation/src/routes/documentation/index.mdx @@ -10,23 +10,23 @@ import Breadcrumbs from '../../components/breadcrumbs' # Tuono -**Tuono is a fullstack framework for building React applications using Rust as +**Tuono is a full-stack framework for building React applications using Rust as the backend.** Tuono (Italian word for "thunder", pronounced /2 Oh No/). Why Tuono? Just a badass name. ## Introduction -**NodeJs/Deno/Bun are the only runtimes that allow a React app to be fullstack right? (no)** +**NodeJs/Deno/Bun are the only runtimes that allow a React app to be full-stack right? (no)** -Tuono is a fullstack React framework with the server side written in Rust. -Because of this Tuono is extremely fast and the requests are handled by multithreaded Rust server. +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 an 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)** Tuono provides a collection of utilities to handle the server side code seamlessly with -the React code. Each server side route is managed with a separate file alongside the React route. +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 @@ -38,7 +38,7 @@ Some of its features include: - 🔥 Hot Module Reload - 🍭 SCSS/CSS modules - 🧬 Server Side Rendering -- 🧵 Multi thread backend +- 🧵 Multi-threaded backend - ⌨️ MDX support - ⚙️ Build optimizations - Custom APIs\* diff --git a/apps/documentation/src/routes/documentation/installation.mdx b/apps/documentation/src/routes/documentation/installation.mdx index 6e89f204..368f6846 100644 --- a/apps/documentation/src/routes/documentation/installation.mdx +++ b/apps/documentation/src/routes/documentation/installation.mdx @@ -13,25 +13,25 @@ import Breadcrumbs, { Element } from '../../components/breadcrumbs' ## Requirements -`Tuono` is a development environment built in rust and typescript that outputs a website written with both the -languages. Since that you need the following tools installed on your computer to work with it: +`Tuono` is a development environment built in rust and typescript that outputs a website written in both the +languages. Since then, you need the following tools installed on your computer to work with it: -- `Rust` - The rust programming language toolchain (Go [here](https://rustup.rs/) for installing both `rust` and `cargo`) +- `Rust` - The Rust programming language tool chain (Go [here](https://rustup.rs/) for installing both `rust` and `cargo`) - `Cargo` - The rust package manager -- `NodeJs` - The Javascript runtime (Go [here](https://nodejs.org/en/download/package-manager) for installing both `nodejs` and `npm`) -- `npm` or `yarn` or `pnpm` - A javascript package manager +- `NodeJs` - The JavaScript runtime (Go [here](https://nodejs.org/en/download/package-manager) for installing both `nodejs` and `npm`) +- `npm` or `yarn` or `pnpm` - A javaScript package manager -> NodeJs is needed just for the development environment. The final output will run on a rust server. +> Node.js is needed just for the development environment. The final output will run on a Rust server. ## Installation -The tuono `CLI` is hosted on [crates.io](https://crates.io/crates/tuono); to download and install it just run on a terminal: +The tuono `CLI` is hosted on [crates.io](https://crates.io/crates/tuono) to download and install it, just run it on a terminal: ```bash cargo install tuono ``` -To check that is correctly installed run: +To check that it is correctly installed, run: ```bash tuono --version diff --git a/apps/documentation/src/routes/index.tsx b/apps/documentation/src/routes/index.tsx index 4b96781a..d598c527 100644 --- a/apps/documentation/src/routes/index.tsx +++ b/apps/documentation/src/routes/index.tsx @@ -5,10 +5,10 @@ export default function IndexPage(): JSX.Element { return ( <> - Tuono - The react/rust fullstack framework + Tuono - The React/Rust full-stack framework