Welcome to Protected Docs – a web application for collaborative document management. This app lets users create private rooms where they can collaboratively work on documents in real time. Each room is password-protected, ensuring that only authorized users can access and edit its contents.
Protected.Docs.mp4
- Create Rooms: Users can create private rooms by entering a password.
- Real-Time Collaboration: Collaborators within the same room can simultaneously edit documents and see changes in real time.
- Document Management: Users can create, edit, and delete documents within their rooms.
- User-Friendly Interface: The app provides an intuitive interface for smooth navigation and document management.
To run the Protected Docs project locally:
- Clone the repository:
git clone https://github.com/your-username/protected-docs.git - Install dependencies:
npm install - Setup your backend server. Refer here: Backend Repo
- Configure the backend and socket URI in config.js (frontend).
- Start the server:
npm start - Access the app: Open a web browser and go to
http://localhost:your-port/roomto create or join a room.
- Visit
http://localhost:your-port/room. - Create a room by entering a password.
- Share the room URL and password with collaborators.
- Collaborators can join the room and start creating and editing documents.
- Real-time changes made by one user are immediately visible to others.
We encourage contributions to enhance the Protected Docs app. To contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature - Implement changes and commit:
git commit -m "Add your changes" - Push changes to your fork:
git push origin feature/your-feature - Open a pull request to the main repository.
For bug reports, feature requests, or assistance, create an issue. Your feedback is valuable to me.
If you have questions or suggestions, feel free to contact us at me4saurabh4u@gmail.com.