Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.84 KB

README.md

File metadata and controls

43 lines (30 loc) · 1.84 KB

English | 中文

FOSScope Toolkit

A toolkit designed for FOSScope contributors

Project Structure

This project is developed with Tauri, with Rust as the backend, and React + Typescript in Vite as the frontend.

Recommended Development Environment

  • IntelliJ IDEA + Rust Plugin
  • VS Code + Tauri extension + rust-analyzer extension
  • Node.js 20.x
  • npm 10.x
  • Newest version of Rust
    • Installed with curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
  • Cargo
  • Tauri CLI
    • Installed with cargo install tauri-cli

Debug

Run cargo tauri dev to start the frontend and backend automatically.

You can also start the frontend with npm run dev, then start the backend and the program window by running the Rust target fosscopetoolkit.

File Structure

  • .vscode:VS Code configuration files for autoconfiguring plugins (auto-generated by Tauri)
  • public:Frontend static resources
  • src:Frontend source code, based on Vite, written in React + TypeScript
  • src-rust:All Rust source code
    • tauri-backend:Tauri backend code, (the src-tauri directory in the default template)
    • toolkit-core:Core library for providing core and basic functionalities
    • toolkit-cli:Command-line version of FOSScope Toolkit, can be released separately, or used for testing core functionalities when the frontend is not fully developed

Contributors

  • @Cubik65536 - Lead Developer & Project Manager
  • @cys2004 - Vice Project Manager & Developer, HTML Processing
  • @sureau2020 - Frontend Developer & Frontend Designer