{"id":28276072,"url":"https://github.com/ahmadoshhamad/realtimedocs","last_synced_at":"2026-04-20T10:03:24.849Z","repository":{"id":294015854,"uuid":"840918155","full_name":"AhmadoshHamad/realTimeDocs","owner":"AhmadoshHamad","description":"Real time document editor aka (google docs)","archived":false,"fork":false,"pushed_at":"2025-05-18T13:01:34.000Z","size":34102,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-16T16:44:18.240Z","etag":null,"topics":["flask","react","restful-api","tailwindcss"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AhmadoshHamad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-11T04:57:36.000Z","updated_at":"2025-05-18T22:49:12.000Z","dependencies_parsed_at":"2025-05-18T14:33:15.571Z","dependency_job_id":null,"html_url":"https://github.com/AhmadoshHamad/realTimeDocs","commit_stats":null,"previous_names":["ahmadoshhamad/realtimedocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AhmadoshHamad/realTimeDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AhmadoshHamad%2FrealTimeDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AhmadoshHamad%2FrealTimeDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AhmadoshHamad%2FrealTimeDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AhmadoshHamad%2FrealTimeDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AhmadoshHamad","download_url":"https://codeload.github.com/AhmadoshHamad/realTimeDocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AhmadoshHamad%2FrealTimeDocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32042294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","react","restful-api","tailwindcss"],"created_at":"2025-05-21T04:17:10.778Z","updated_at":"2026-04-20T10:03:24.806Z","avatar_url":"https://github.com/AhmadoshHamad.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RealTimeDocs - Collaborative Document Editor\n\n## Project Overview\n\nRealTimeDocs is a real-time collaborative document editing platform inspired by Google Docs. This application allows users to create, edit, and collaborate on documents in real-time with multiple users simultaneously.\n\nThe project demonstrates the implementation of modern web technologies including React, Redux, Flask WebSockets, and real-time collaborative features.\n\n\n\n## The Challenge\n\nThis project was developed as part of a one-week coding challenge to create a Google Docs-like application with real-time collaboration features. The challenge covered:\n\n\n\u003c!-- ![RealTimeDocs Screenshot](login.png) --\u003e\n\n## Features\n\n- **Real-time Collaboration**: Edit documents simultaneously with multiple users\n- **User Authentication**: Secure login and registration system\n- **Document Management**: Create, view, edit and delete documents\n\u003c!-- - **Document Sharing**: Share documents with other users --\u003e\n- **Rich Text Editing**: Format text with various styling options\n- **Spreadsheet Support**: Basic spreadsheet functionality (similar to Google Sheets)\n- **Responsive Design**: Works on desktop and mobile devices\n\n## Tech Stack\n\n### Frontend\n- React.js with Vite\n- Redux \u0026 Redux Saga for state management\n- Socket.IO client for real-time communication\n- TailwindCSS for styling\n- React Router for navigation\n- React-Quill for rich text editing\n\n### Backend\n- Flask (Python web framework)\n- Flask-SocketIO for WebSockets\n- SQLAlchemy for database ORM\n- JWT for authentication\n- RESTful API architecture\n\n## Installation and Setup\n\n### Prerequisites\n- Node.js (v14+)\n- Python (v3.8+)\n- Git\n\n### Backend Setup\n\n1. Clone the repository\n```bash\ngit clone https://github.com/yourusername/realTimeDocs.git\ncd realTimeDocs\n```\n\n2. Set up the Python virtual environment\n```bash\ncd flask-websocket\npython -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\n```\n\n3. Install dependencies\n```bash\npip install -r requirements.txt\n```\n\n4. Create a `.env` file in the flask-websocket directory with the following:\n```\nSQLALCHEMY_DATABASE_URI=sqlite:///instance/users.db\nAPP_SECRET_KEY=your-secret-key-here\n```\n\n5. Run the Flask server\n```bash\npython app.py\n```\nThe server will run on http://localhost:5001\n\n### Frontend Setup\n\n1. Navigate to the React project directory\n```bash\ncd ../react-websocket\n```\n\n2. Install dependencies\n```bash\nnpm install\n```\n\n3. Create a `.env` file in the react-websocket directory with:\n```\nVITE_SOCKET_URL=http://localhost\nVITE_SOCKET_PORT=5001\n```\n\n4. Start the development server\n```bash\nnpm run dev\n```\nThe application will be available at http://localhost:5173\n\n## Project Structure\n\n```\nrealTimeDocs/\n├── flask-websocket/       # Backend Flask application\n│   ├── app.py             # Main Flask application\n│   ├── models.py          # Database models\n│   └── requirements.txt   # Python dependencies\n└── react-websocket/       # Frontend React application\n    ├── public/            # Static files\n    ├── src/               # Source code\n    │   ├── components/    # React components\n    │   ├── pages/         # Page components\n    │   ├── actions/       # Redux actions\n    │   ├── reducers/      # Redux reducers\n    │   ├── App.jsx        # Main application component\n    │   └── main.jsx       # Application entry point\n    ├── package.json       # Node.js dependencies\n    └── vite.config.js     # Vite configuration\n```\n\n## Usage\n\n1. Register a new account or login with existing credentials\n2. Create a new document from the dashboard\n3. Edit your document with the rich text editor\n4. Share your document with other users via the share button\n5. Collaborate in real-time with shared users\n\n## Future Improvements\n\n- Enhanced document organization with folders\n- More advanced text formatting options\n- Comment and suggestion features\n- Version history and document recovery\n- Mobile application support\n\n\nDeveloped as part of a one-week coding challenge\n\n\n\u003e \"Salamat Team,  \n\u003e I know that you are looking forward to this, its gonna be fun, full of information, and challenging.\n\u003e This is something you need to learn yourself, and the 1 week timeline is something you need to use wisely.\n\u003e By the end of this week you will be amazed how much you achieved, and how powerful our brains are.\"\n\n### Challenge Requirements:\n\n- **React.js, Vite, Tailwind CSS**\n- **Understanding of Browser Rendering**:\n  - Browser rendering process\n  - DOM and CSSOM trees\n  - Event loop and task queue in JavaScript\n- **Front-end Skills**:\n  - HTML semantics and structure\n  - Advanced CSS (Flexbox, Grid, responsive design)\n  - JavaScript (closures, prototypes, ES6+, async programming)\n- **React.js Implementation**:\n  - Context API, Hooks (useState, useEffect, useReducer)\n  - Component lifecycle and best practices\n  - State management\n- **State Management**:\n  - Redux architecture\n  - Redux Saga for side effects\n- **Real-Time Collaboration Features**:\n  - Document editing with multiple users\n  - WebSocket communication\n  - User authentication and document sharing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadoshhamad%2Frealtimedocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmadoshhamad%2Frealtimedocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadoshhamad%2Frealtimedocs/lists"}