commit 5d28ffcf33ad5b007d06651a5b363e93745c8d65 Author: Valerio Ageno Date: Sat Apr 27 10:10:50 2024 +0200 feat: scaffold project [Let's smash it\!] diff --git a/README.md b/README.md new file mode 100644 index 00000000..de8e9919 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Tuono.js + +The fullstack react/rust framework. + +> This project is under heavy development. API might drastically change! + +## Features +- Rust based server side rendering +- FS routing +- CSS modules + +## Folder structure + +``` +- public/ +- src/ +| - routes/ +| | - api/ +``` diff --git a/REPO.md b/REPO.md new file mode 100644 index 00000000..638638e5 --- /dev/null +++ b/REPO.md @@ -0,0 +1,25 @@ +# Repository structure doc + +## Monorepo tool +- [Turborepo](https://turbo.build/repo) + +## Packages +> Highly inspired by [@tanstack/router](https://tanstack.com/router/latest) + +- vite-fs-router + - vite plugin interface + - router generator +- react-router +- react-router-server +- tuono-runtime (entry point) + +### JS Public interface +- tuono-runtime (all in one js framework package) + +## Crates +- tuono (cli interface) +- tuono-axum-builder (axum project builder) +- tuono-watch (folder watch reload) + +### Rust Public interface +- tuono (cli, dev and prod environment) diff --git a/packages/vite-fs-router/README.md b/packages/vite-fs-router/README.md new file mode 100644 index 00000000..6c1c9de8 --- /dev/null +++ b/packages/vite-fs-router/README.md @@ -0,0 +1,5 @@ +# [Tuono] Vite FS Router + +This is the [vite](https://vitejs.dev/) plugin that automatically handles the file system routing. + + diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml new file mode 100644 index 00000000..dee51e92 --- /dev/null +++ b/pnpm-workspace.yaml @@ -0,0 +1,2 @@ +packages: + - "packages/*" diff --git a/turbo.json b/turbo.json new file mode 100644 index 00000000..17e6cb8a --- /dev/null +++ b/turbo.json @@ -0,0 +1,3 @@ +{ + "$schema": "https://turbo.build/schema.json" +}