{"id":21502305,"url":"https://github.com/sitmcella/doc-versions","last_synced_at":"2026-04-10T02:02:33.836Z","repository":{"id":152363187,"uuid":"625195544","full_name":"sitMCella/doc-versions","owner":"sitMCella","description":"Document Versions is a web application that manages the versions of text documents via Git","archived":false,"fork":false,"pushed_at":"2023-05-09T18:15:54.000Z","size":276,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T23:32:03.301Z","etag":null,"topics":["documentation-tool","draft-js","git","gitgraph","graph","javascript","react-draft-wysiwyg","reactjs","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sitMCella.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-04-08T11:04:12.000Z","updated_at":"2023-12-31T23:24:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"cd0d6712-9a4b-45ac-9966-d5b5a0f6277f","html_url":"https://github.com/sitMCella/doc-versions","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitMCella%2Fdoc-versions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitMCella%2Fdoc-versions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitMCella%2Fdoc-versions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitMCella%2Fdoc-versions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sitMCella","download_url":"https://codeload.github.com/sitMCella/doc-versions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244043488,"owners_count":20388591,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["documentation-tool","draft-js","git","gitgraph","graph","javascript","react-draft-wysiwyg","reactjs","rust"],"created_at":"2024-11-23T18:14:19.737Z","updated_at":"2025-12-31T00:18:20.803Z","avatar_url":"https://github.com/sitMCella.png","language":"Rust","readme":"# Document Versions\n\n![Document](https://github.com/sitMCella/doc-versions/wiki/images/Document.png)\n\n## Table of contents\n\n* [Introduction](#introduction)\n* [Development](#development)\n    * [Setup Development](#setup-development)\n    * [Configuration Development](#configuration-development)\n    * [Build Project Development](#build-project-development)\n* [Production](#production)\n  * [Setup Production](#setup-production)\n  * [Configuration Production](#configuration-production)\n  * [Build Project Production](#build-project-production)\n\n## Introduction\n\nDocument Versions is a web application that manages the versions of text documents via Git.\nIn the current version of the application, the files are stored in the local environment.\n\nRead the [documentation](https://github.com/sitMCella/doc-versions/wiki) in order to discover the features of Document Versions.\n\n## Development\n\nDocument Versions is a web application built using the Rust language on the backend, and React JS framework on the frontend.\nDocument Versions stores and versions the files using a Git client via the libgit2 library for Rust.\n\n### Setup Development\n\nInstall Node.js. Recommended version \u003e= 19.5.0\n\nInstall Rust and Cargo. Recommended version:\n- Rustc and Cargo \u003e= 1.63.0\n\n### Configuration Development\n\nConfigure the root directory for the workspaces in 'backend/configuration.yaml'.\n\nConfigure the root directory for the backed tests in 'backend/configuration_test.yaml'.\n\n### Build Project Development\n\n#### Run Unit and Integration Tests (Backend)\n\n``` sh\ncd ./backend\ncargo test  -- --nocapture\n```\n\n#### Rust Code Coverage\n\n```sh\ncd ./backend\ncargo tarpaulin --ignore-tests\n```\n\n#### Rust Linter\n\n```sh\ncd ./backend\ncargo clippy -- -D warnings\n```\n\n#### Format Code (Backend)\n\n```sh\ncd ./backend\ncargo fmt\n```\n\n#### Build (Backend)\n\n``` sh\ncd ./backend\ncargo build\n```\n\n#### Build (Frontend)\n\n``` sh\ncd ./frontend\nnpm run build\n```\n\n#### Format Code (Frontend)\n\n```sh\ncd ./frontend\nnpm run lint\n```\n\n#### Eslint Check:\n\n```sh\ncd ./frontend\neslint --ext .jsx,.js src/\n```\n\n#### Eslint Format:\n\n```sh\ncd ./frontend\neslint --fix --ext .jsx,.js src/\n```\n\n#### Run application\n\n#### Run Application Backend\n\n``` sh\ncd ./backend\ncargo run\n```\n\n#### Run Application Frontend\n\n``` sh\ncd ./frontend\nnpm run start\n```\n\n#### Run Application Frontend (Electron)\n\n``` sh\ncd ./frontend\nnpm run dev\n```\n\n#### Access the application\n\n```sh\nhttp://localhost:3000\n```\n\n## Production\n\n### Setup Production\n\nInstall Node.js. Recommended version \u003e= 19.5.0\n\nInstall Docker and Docker Compose.\n\n### Configuration Production\n\nConfigure the root directory for the workspaces in 'backend/configuration.yaml' with the following content:\n\n``` yaml\napplication_port: 8000\nworkspaces_path: \"/app/git-workspace\"\n```\n\n### Build Project Production\n\n#### Build (Backend)\n\n``` sh\ncd ./backend\ncargo build --release\n```\n\n#### Build (Frontend)\n\n``` sh\ncd ./frontend\nnpm run build\n```\n\n#### Build Docker Images\n\n``` sh\ndocker-compose build\n```\n\n#### Run application\n\n```sh\ndocker-compose up\n```\n\n#### Access the application\n\n```sh\nhttp://localhost:80\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitmcella%2Fdoc-versions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsitmcella%2Fdoc-versions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitmcella%2Fdoc-versions/lists"}