{"id":26391544,"url":"https://github.com/royaals/docs-webs","last_synced_at":"2026-04-05T23:02:12.878Z","repository":{"id":254661438,"uuid":"847041188","full_name":"royaals/docs-webs","owner":"royaals","description":"Docs web application that allows users to create, edit, and collaborate on rich text documents in real-time. ","archived":false,"fork":false,"pushed_at":"2024-08-25T06:03:30.000Z","size":193,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-03T16:32:22.607Z","etag":null,"topics":["material-ui","mongodb","nodejs","quill-editor","reactjs","websocket"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/royaals.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}},"created_at":"2024-08-24T17:18:01.000Z","updated_at":"2024-10-17T04:10:05.000Z","dependencies_parsed_at":"2024-08-25T06:45:51.073Z","dependency_job_id":null,"html_url":"https://github.com/royaals/docs-webs","commit_stats":null,"previous_names":["royaals/docs-webs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/royaals/docs-webs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royaals%2Fdocs-webs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royaals%2Fdocs-webs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royaals%2Fdocs-webs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royaals%2Fdocs-webs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/royaals","download_url":"https://codeload.github.com/royaals/docs-webs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royaals%2Fdocs-webs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31452901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"ssl_error","status_checked_at":"2026-04-05T21:22:51.943Z","response_time":75,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["material-ui","mongodb","nodejs","quill-editor","reactjs","websocket"],"created_at":"2025-03-17T10:20:28.060Z","updated_at":"2026-04-05T23:02:12.837Z","avatar_url":"https://github.com/royaals.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docs WebApp\r\n\r\n## Overview\r\n\r\n Docs web application that allows users to create, edit, and collaborate on rich text documents in real-time. It leverages modern web technologies, including **React** for the frontend, **Node.js** for the backend, **MongoDB** for data storage, **Socket.io** for real-time communication, **Material UI** for UI components, and **Quill** as the rich text editor.\r\n\r\n## Features\r\n\r\n- **Real-time Collaboration:** Multiple users can edit a document simultaneously, with changes synced in real-time across all connected clients.\r\n- **Rich Text Editing:** The app features a rich text editor powered by Quill, allowing users to format their documents with ease.\r\n- **Document Management:** Users can create, view, and manage multiple documents.\r\n- **Persistent Storage:** Documents are stored in a MongoDB database, ensuring that changes are saved and retrievable.\r\n- **Responsive Design:** The application is built with Material UI, ensuring a responsive and user-friendly interface on various devices.\r\n\r\n## Tech Stack\r\n\r\n- **Frontend:**\r\n  - React: A JavaScript library for building user interfaces.\r\n  - Material UI: A popular React UI framework for building sleek and responsive interfaces.\r\n  - Quill: A rich text editor for formatting content.\r\n  \r\n- **Backend:**\r\n  - Node.js: A JavaScript runtime used for server-side programming.\r\n  - Express: A web application framework for Node.js, used to build the API.\r\n  - Socket.io: A library for enabling real-time, bidirectional communication between clients and servers.\r\n  \r\n- **Database:**\r\n  - MongoDB: A NoSQL database used to store document data.\r\n\r\n## Installation\r\n\r\n### Prerequisites\r\n\r\nEnsure you have the following installed:\r\n\r\n- Node.js (v14.x or later)\r\n- MongoDB\r\n- npm (Node Package Manager)\r\n\r\n### Setup\r\n\r\n1. Clone the repository:  \r\n   ```bash\r\n   git clone https://github.com/royaals/docs-webs.git\r\n   ```\r\n2. Navigate to the backend directory and install the dependencies:\r\n    ```bash\r\n    cd backend\r\n    npm install\r\n    ```\r\n3. Rename `.env.example` to `.env` in the backend folder:\r\n\r\n    - `DB_URL`: This should be your MongoDB database URL. For example, if you're using Docker, it would look something like this: `mongodb://localhost:27017/mydatabase`. If you're using a Cloud Mongodb Atlas use the URL they provide. \r\n\r\n   Using Docker for MongoDB:\r\n    ```bash\r\n    docker pull mongo\r\n    docker run -d -p 27017:27017 --name mongodb mongo\r\n    ```\r\n\r\n4. Navigate to the frontend directory and install the dependencies:\r\n    ```bash\r\n    cd frontend\r\n    npm install\r\n    ```\r\n5. Start the backend server:\r\n    ```bash\r\n    cd backend\r\n    node index.js\r\n    ```\r\n6. Start the frontend server:\r\n    ```bash\r\n    cd frontend\r\n    npm start\r\n    ```    \r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froyaals%2Fdocs-webs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froyaals%2Fdocs-webs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froyaals%2Fdocs-webs/lists"}