init
This commit is contained in:
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# RocketTools - Rocket Propulsion Engineering Calculator
|
||||
|
||||
RocketTools is a web-based application that provides engineering calculators and tools for rocket propulsion. Built with React and Vite, it serves both students learning aerospace engineering concepts and professional engineers performing complex propulsion calculations.
|
||||
|
||||
## Project Status
|
||||
|
||||
✅ Documentation Finalized and Approved
|
||||
✅ Core Functionality Implemented
|
||||
🚧 Additional Features in Development
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Equation Solver**: Drag-and-drop interface for rocketry variables with automatic solving
|
||||
- **Engine Designer**: 3D visualization of engine models using React Three Fiber
|
||||
- **Knowledge Base**: Reference materials for fuels and oxidizers
|
||||
- **Export Capabilities**: Save results in ODT and JSON formats
|
||||
|
||||
## Project Documentation
|
||||
|
||||
All project documentation has been finalized and approved:
|
||||
|
||||
- [Project Overview (Final)](PROJECT_OVERVIEW_FINAL.md)
|
||||
- [Project Structure (Final)](PROJECT_STRUCTURE_FINAL.md)
|
||||
- [Approved Consolidated Document](ROCKETTOOLS_PROJECT_APPROVED.md)
|
||||
- [Stakeholder Overview](PROJECT_DESCRIPTION_STAKEHOLDER.md)
|
||||
- [Consolidated Refined Documentation](ROCKETTOOLS_CONSOLIDATED_REFINED.md)
|
||||
- [Consolidated Refined Documentation](ROCKETTOOLS_CONSOLIDATED_REFINED.md)
|
||||
|
||||
## Technology Stack
|
||||
|
||||
- React 19 with Vite
|
||||
- React Three Fiber for 3D visualization
|
||||
- DnD Kit for drag-and-drop functionality
|
||||
- TailwindCSS for styling
|
||||
- React Router for navigation
|
||||
|
||||
## Development Setup
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
|
||||
|
||||
Currently, two official plugins are available:
|
||||
|
||||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
|
||||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
|
||||
|
||||
## React Compiler
|
||||
|
||||
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
|
||||
|
||||
## Expanding the ESLint configuration
|
||||
|
||||
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
|
||||
Reference in New Issue
Block a user