Welcome to AquaCoder, a real-time mermaid diagram interpreter designed for collaborative use 🤝. This platform leverages the power of Liveblocks to enable multiple users to work on mermaid diagrams simultaneously, in real-time 🚀. Whether you're a team of developers 👩💻👨💻, a group of students 📚, or just someone looking to create complex diagrams with others, AquaCoder offers a seamless and intuitive interface to bring your ideas to life 🌟.
- Real-time Collaboration: Work with team members on the same diagram in real time, thanks to the integration with Liveblocks 🤝.
- Mermaid Support: Full support for mermaid syntax, allowing you to create a wide range of diagrams including flowcharts, sequence diagrams, class diagrams, and more 📊.
- Intuitive Interface: A user-friendly interface that makes diagram creation as simple as typing markdown ✍️.
To start using AquaCoder, follow these simple steps:
- Visit AquaCoder: Open your browser and go to the AquaCoder website 🌐.
- Create or Join a Room: You can start a new diagram or join an existing session using a unique session ID 📝.
- Start Collaborating: Once in a session, you can start creating your mermaid diagram. Invite others to join by sharing the session ID 🎉.
Or run it locally:
- Clone reporsitory:
git clone https://github.com/WizzzStark/ProtoForge- Install dependecies:
cd protoforge
npm install- Create an account in liveblocks.io
-
Copy public key administration
-
Create
.env.localand add the variableLIVEBLOCKS_SECRET_KEY=public_key
- Run de server:
npm run devAquaCoder runs in your web browser, so there's no need to install software on your computer. However, for the best experience, I recommend using the latest version of Google Chrome, Mozilla Firefox, or Safari 🌍.
- Next.js - The React framework for production
- Liveblocks - Real-time collaboration APIs
- Mermaid - Generation of diagram and flowchart from text in a similar manner as markdown
Contributions are welcome to AquaCoder! If you have suggestions for improvements or bug fixes, please feel free to fork the repository and submit a pull request.
AquaCoder is released under the MIT License. See the LICENSE file for more details.
- Thanks to the Liveblocks team for making real-time collaboration easier to implement.
- Hat tip to the creators of Mermaid for their fantastic tool that powers our diagram interpretations.
Happy Diagramming! 🎈