TrEdit& is an Editor.JS based editor, enabling user to edit, create and collaborate with others. All this while using Ably to provide a real-time experience for seam-less interaction. Create, organize, share and collaborate with others all while working with others at the same time.
TrEdit is not just about real-time editing, it's also based on a solid architecture. A few features of TrEdit are, :
- Real-time data synchronization with database,
- Users can collaborate with others and share there work,
- Modern and minimalistic editor with many editing tools,
- Real-time editing while working with others,
It looks like you've started working on a README for a project called "TrEdit." A README is a great way to introduce your project to potential users and contributors. It provides information about what the project does, how to use it, and other relevant details. Here's a suggestion to complete the "Usage" section:
To use TrEdit, follow these steps:
-
Clone the Repository: Start by cloning the TrEdit repository to your local machine.
git clone https://github.com/Ranaco/tredit.git
-
Install Dependencies: Navigate to the project directory and install the necessary dependencies.
cd tredit npm install -
Configuration: Set up any required configuration, such as API keys, in the project.
-
Run the Application: Launch the TrEdit application.
npm run dev
-
Access the Editor: Open a web browser and visit
http://localhost:3000to access the TrEdit editor. -
Start Collaborating: Begin creating, editing, and collaborating in real-time with others using the powerful Editor.JS-based editor.
Frontend:
Backend:
- Next.js API (API route calls)
- Ably (Realtime service)
- Supabase (Database)
Additional Technologies and Dependencies:
If you want to contribute to the project, please follow the guidelines in the Contributing file.
This project is licensed under the XYZ License - see the LICENSE file for details.
We would like to thank the following contributors for their valuable input and support.
Feel free to adapt and expand this "Usage" section to provide specific details about how users can interact with and make the most of your TrEdit project. Additionally, don't forget to fill in the "Contributing," "License," and "Acknowledgements" sections with appropriate information.