{"id":22904289,"url":"https://github.com/MiniaczQ/apsi-document-versioning","last_synced_at":"2025-08-12T06:31:19.065Z","repository":{"id":149897017,"uuid":"619525595","full_name":"MiniaczQ/apsi-document-versioning","owner":"MiniaczQ","description":"Document versioning web application.","archived":true,"fork":false,"pushed_at":"2023-06-30T15:39:23.000Z","size":1770,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T08:26:50.804Z","etag":null,"topics":["react","rust","versioning"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/MiniaczQ.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":"2023-03-27T10:10:14.000Z","updated_at":"2025-01-06T13:46:36.000Z","dependencies_parsed_at":"2023-07-03T02:24:34.663Z","dependency_job_id":null,"html_url":"https://github.com/MiniaczQ/apsi-document-versioning","commit_stats":null,"previous_names":["miniaczq/apsi-document-versioning"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MiniaczQ/apsi-document-versioning","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MiniaczQ%2Fapsi-document-versioning","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MiniaczQ%2Fapsi-document-versioning/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MiniaczQ%2Fapsi-document-versioning/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MiniaczQ%2Fapsi-document-versioning/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MiniaczQ","download_url":"https://codeload.github.com/MiniaczQ/apsi-document-versioning/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MiniaczQ%2Fapsi-document-versioning/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270014254,"owners_count":24512612,"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","status":"online","status_checked_at":"2025-08-12T02:00:09.011Z","response_time":80,"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":["react","rust","versioning"],"created_at":"2024-12-14T02:45:43.346Z","updated_at":"2025-08-12T06:31:19.031Z","avatar_url":"https://github.com/MiniaczQ.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# About\r\n\r\nThis is a document versioning application made for a college course.\r\n\r\n# Requirements\r\n\r\nSet environmental variable `DOCKER_BUILDKIT=1`\r\n\r\n# Running\r\n\r\n\u003eThis environment hosts the entire application on `localhost:3000`.\r\n\r\nStart:\r\n```sh\r\ndocker compose --profile all up -d --build\r\n```\r\n\r\nStop:\r\n```sh\r\ndocker compose --profile all down\r\n```\r\n\r\nCleanup:\r\n```sh\r\ndocker compose --profile all down -v\r\n```\r\n\r\n# Development\r\n\r\n## Frontend\r\n\r\n### Databse + Backend environment\r\n\r\n\u003eThis environment has to be running during frontend development.\r\n\r\nStart:\r\n```sh\r\ndocker compose --profile backend up -d --build\r\n```\r\n\r\nStop:\r\n```sh\r\ndocker compose --profile backend down\r\n```\r\n\r\nCleanup:\r\n```sh\r\ndocker compose --profile backend down -v\r\n```\r\n\r\n### Frontend\r\n\r\nStart:\r\n```sh\r\nnpm run --prefix frontend start\r\n```\r\n`Ctrl-C` to quit.\r\n\r\n## Backend\r\n\r\n### Databse environment\r\n\r\n\u003eThis environment has to be running during backend development.\r\n\r\nStart:\r\n```sh\r\ndocker compose --profile db up -d\r\n```\r\n(no `--build` because we are using pre-made images)\r\n\r\nStop:\r\n```sh\r\ndocker compose --profile db down\r\n```\r\n\r\nCleanup:\r\n```sh\r\ndocker compose --profile db down -v\r\n```\r\n\r\n### Backend\r\n\r\nStart:\r\n```sh\r\ncd backend\r\ncargo run\r\ncd ..\r\n```\r\n\r\n# API documentation\r\n\r\nBecause Rust webservers are young, there aren't many OpenAPI generators, most of them require boilerplate.  \r\nFor that reason Postman is used and kept up to date in the [`Apsi.postman_collection.json`](./Apsi.postman_collection.json) file.\r\n\r\nThe simplest usage requires you to register, then login and copy JWT token into collection global variables.  \r\nFurther usage is adequate.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMiniaczQ%2Fapsi-document-versioning","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMiniaczQ%2Fapsi-document-versioning","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMiniaczQ%2Fapsi-document-versioning/lists"}