Welcome to visionMaps, a pioneering repository dedicated to transforming the way we interact with assembly instructions for furniture and other do-it-yourself projects. This repository hosts the codebase for an innovative application that presents visual instructions in a format similar to navigational aids like Google Maps. As users progress through the assembly steps, the app visually depletes the materials (screws, nails, etc.) to provide a clear and dynamic guide to completing their project.
visionMaps is designed to enhance the experience of assembling products by offering an interactive, step-by-step visual guide that simplifies the process. The application is particularly suited for spatial computing devices, where it can leverage AR (Augmented Reality) to superimpose instructions onto the real-world environment, making the assembly process intuitive and engaging.
- Visual Instruction Flow: Like a navigation system for assembly, guiding users through each step with clarity.
- Material Tracker: Dynamically updated list of materials that depletes as the user progresses through the instructions.
- Spatial Computing Integration: Compatibility with AR and other spatial computing technologies to project instructions onto the physical workspace.
- Interactive UI: User-friendly interface that allows for easy navigation through the assembly process.
To set up visionMaps for development or usage, follow these steps:
git clone https://github.com/vector-y/visionMaps.git
cd visionMaps
cd frontend && npm install & npm run dev
# Follow specific instructions for setting up the backend and frontendOnce installed, you can run visionMaps to view visual instructions for a variety of furniture assembly tasks. The app will provide you with a list of hardware required for the assembly (screws, nails, etc.) and will update in real-time as you use each item.
Contributions to visionMaps are welcome! If you have an idea for improving the application, please fork the repository and submit a pull request. For more detailed information, refer to CONTRIBUTING.md (to be created).
Thank you to Victor and all the contributors who have spent their time and effort to bring visionMaps to life.
For support, feature requests, or bug reporting, please submit an issue on the GitHub issue tracker.
The current status of visionMaps is in active development. Check out the CHANGELOG for the latest updates and feature releases.
This project is licensed under the MIT License - see the LICENSE file for details.
Please note that the information provided above is based on the assumed functionality of the visionMaps project. Adjust the README.md to reflect the actual capabilities and status of the project.