diff --git a/README.md b/README.md index 0239427d781b1ab433aebbd9e3e2aaf922ee9a8d..388cfb7b5aa46e8f74b88fadbf4a20c6be7740a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ + + # robot-navigation-system -An Electron application with React and TypeScript +An Electron application with React and TypeScript for robot navigation visualization and control. + +## Project Overview + +This is a desktop application built with Electron, React, and TypeScript that provides a robot navigation system. The application includes 3D visualization capabilities, path planning features, and a modern React-based UI. + +## Technology Stack + +- **Frontend Framework**: React 18+ +- **Desktop Framework**: Electron +- **Language**: TypeScript +- **Build Tool**: Vite (electron-vite) +- **State Management**: Redux with persistence +- **3D Visualization**: nova3D +- **UI Styling**: Tailwind CSS + SCSS ## Recommended IDE Setup @@ -8,7 +24,7 @@ An Electron application with React and TypeScript ## Project Setup -### Install +### Install Dependencies ```bash $ yarn @@ -16,14 +32,18 @@ $ yarn ### Development +Start the application in development mode: + ```bash $ yarn dev ``` ### Build +Build the application for different platforms: + ```bash -# For windows +# For Windows $ yarn build:win # For macOS @@ -32,3 +52,42 @@ $ yarn build:mac # For Linux $ yarn build:linux ``` + +## Project Structure + +``` +├── src/ +│ ├── main/ # Electron main process +│ │ └── index.ts # Window creation and management +│ ├── preload/ # Preload scripts for IPC +│ │ └── index.ts # Secure bridge between main and renderer +│ └── renderer/ # React application (renderer process) +│ ├── api/ # API service modules +│ ├── assets/ # Static assets (CSS, images) +│ ├── components/ # Reusable React components +│ ├── nova3D/ # 3D viewer and visualization +│ ├── redux/ # State management +│ ├── router/ # Application routing +│ ├── service/ # HTTP and storage services +│ ├── styles/ # Global styles and themes +│ ├── theme/ # Theme configuration +│ └── views/ # Page-level components +│ ├── Home/ +│ ├── Manage/ +│ ├── Navigation/ +│ └── Repository/ +├── build/ # Build resources (icons, entitlements) +└── electron.vite.config.* # Vite configuration for Electron +``` + +## Features + +- **3D Navigation Visualization**: View and interact with robot navigation paths in 3D +- **Path Planning**: Plan and manage navigation routes +- **Repository Management**: Browse and manage navigation data +- **State Persistence**: Redux state management with data persistence +- **Cross-Platform**: Support for Windows, macOS, and Linux + +## License + +Please refer to the LICENSE file in the repository for licensing information. \ No newline at end of file