{"id":20126030,"url":"https://github.com/asgarzee/document-manager","last_synced_at":"2025-03-02T21:14:16.312Z","repository":{"id":253240158,"uuid":"802456260","full_name":"asgarzee/document-manager","owner":"asgarzee","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-15T11:09:42.000Z","size":517,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-13T08:12:22.965Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/asgarzee.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-05-18T10:49:00.000Z","updated_at":"2024-08-15T11:09:45.000Z","dependencies_parsed_at":"2024-08-15T12:47:32.057Z","dependency_job_id":"d3762f4e-e888-4941-a50c-cb4964e0362e","html_url":"https://github.com/asgarzee/document-manager","commit_stats":null,"previous_names":["asgarzee/document-manager"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asgarzee%2Fdocument-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asgarzee%2Fdocument-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asgarzee%2Fdocument-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asgarzee%2Fdocument-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asgarzee","download_url":"https://codeload.github.com/asgarzee/document-manager/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241570919,"owners_count":19984002,"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":[],"created_at":"2024-11-13T20:12:43.028Z","updated_at":"2025-03-02T21:14:16.289Z","avatar_url":"https://github.com/asgarzee.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Document Manager\n\nThe Document Management is a simple web application consisting of a basic API backend and a React based client.\n\n## Documentation\n#### You can find High level Design Document at /docs/HLD.md\n\n## Getting Started\n## Tech Stack\n\n**Server:** Django, SQLite\n\n### Client Development \nThe client project is a [Create React App](https://create-react-app.dev/) that has been tested against [Node v18.19.0 Hydrogen LTS](https://nodejs.org/download/release/v18.19.0/).  An [.nvmrc](https://github.com/nvm-sh/nvm#calling-nvm-use-automatically-in-a-directory-with-a-nvmrc-file) file has been included so that the command `$ nvm use` should select the correct NodeJS version through NVM.\n1. Navigate to the client/doc-manager directory.\n2. `$ npm install` to install the dependencies.\n3. `$ npm start` to start the React development server.\n\n## Initial Setup\n\n### 1. Install Docker\nFollow link to install [Docker](https://www.docker.com/products/docker-desktop/) https://www.docker.com/products/docker-desktop/\n\n### 2. Create two directories media and static \n```shell\ncd document-manager\nmkdir src/propylon_document_manager/media src/propylon_document_manager/static\n```\n\n###3. Build Django Server\n```shell\ndocker compose up\n```\nServer will be serving at http://0.0.0.0:8001/\n\n###4. Create a User to start with the APIs\n```shell\nmake createsuperuser\n```\n\n\n## Following are some useful commands\n#### Run a User\n```shell\nmake createsuperuser\n```\n\n#### Run Migrations\n```shell\nmake make-migrations\n```\n\n#### Run Tests\n```shell\nmake test\n```\n\n#### Reformat Code\n```shell\nmake format\n```\n\n#### Reformat Code\n```shell\nmake format\n```\n\n#### Check Linting Issues\n```shell\nmake lint\n```\n\n#### Fix Linting Issues\n```shell\nmake lint-fix\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasgarzee%2Fdocument-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasgarzee%2Fdocument-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasgarzee%2Fdocument-manager/lists"}