{"id":19857039,"url":"https://github.com/griffithlab/civic-client","last_synced_at":"2025-05-02T02:30:33.245Z","repository":{"id":19736945,"uuid":"22993377","full_name":"griffithlab/civic-client","owner":"griffithlab","description":"Web client for CIViC: Clinical Interpretations of Variants in Cancer","archived":false,"fork":false,"pushed_at":"2023-11-28T01:44:36.000Z","size":29343,"stargazers_count":50,"open_issues_count":243,"forks_count":27,"subscribers_count":26,"default_branch":"staging","last_synced_at":"2025-04-06T21:02:22.127Z","etag":null,"topics":["cancer","cancer-genomics","civic","front-end-framework","javascript","nci-itcr","variants"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/griffithlab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2014-08-15T15:08:38.000Z","updated_at":"2023-09-11T08:55:46.000Z","dependencies_parsed_at":"2023-01-12T02:45:51.711Z","dependency_job_id":"d17d4575-d30c-4bf8-98dc-6ad07d9bfbe6","html_url":"https://github.com/griffithlab/civic-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griffithlab%2Fcivic-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griffithlab%2Fcivic-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griffithlab%2Fcivic-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griffithlab%2Fcivic-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/griffithlab","download_url":"https://codeload.github.com/griffithlab/civic-client/tar.gz/refs/heads/staging","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251972410,"owners_count":21673599,"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":["cancer","cancer-genomics","civic","front-end-framework","javascript","nci-itcr","variants"],"created_at":"2024-11-12T14:17:18.031Z","updated_at":"2025-05-02T02:30:28.234Z","avatar_url":"https://github.com/griffithlab.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"civic-client\n============\n\n[![DOI](https://zenodo.org/badge/22993377.svg)](https://zenodo.org/badge/latestdoi/22993377)\n\n\nDeveloping for CIViC involves setting up a development environment. To get started quickly, we recommend launching an AWS EC2 instance from our pre-configured and maintained AMI ([getting started wiki page](https://github.com/genome/civic-server/wiki/Getting-Started-with-CIViC-Development-on-AWS)).\n\nAlternatively, you may set up your own local development environment using the following setup instructions.\n\n## To Install\n\ncivic-client uses yarn for development, build, and resource server tasks, so ensure that you have yarn (and nodeJS) installed and running. Yarn installation instructions are here:\n\nhttps://yarnpkg.com/lang/en/docs/install/\n\nOnce you've installed Yarn, clone the civic-client repository and cd to it, then:\n\n```bash\nyarn install\n```\n\nYarn will determine the packages it needs to install, download, and install them for you - it may take awhile. Then we need to install bower, which manages client-side packages:\n\n```bash\nyarn global add bower\n```\n\nOnce bower is installed, use it to install civic-client's runtime libraries:\n\n```bash\nbower install\n```\n\nIf bower becomes confused about which Angular version to use, pick the first one that offers version 1.3.15.\n\n## Development\n\nCIViC client uses the gulp workflow system for serving, watching, building, and testing the client codebase. Let's install that:\n\n```bash\nyarn global add gulp\n```\n\nOnce we have gulp installed, start up the CIViC server (execute `rails s` from the server's root directory), then start up the client server with:\n\n```bash\ngulp serve\n```\n\nThen load `http://127.0.0.1:3001` in your browser. *NOTE:* use `127.0.0.1`, not `localhost`. A couple of the OAuth providers we use for authentication will only work if the app is loaded from `127.0.0.1`. \n\nThe `serve` tasks starts a static file server, and a proxy that routes calls to /api to the civic-server listening on port 3000. It serves the AngularJS application, and a starts a watch task which watches all files for changes and lints, builds and injects them into the index.html accordingly.\n\n## Production ready build - a.k.a. dist\n\nTo make the app ready for deploy to production run:\n\n```bash\ngulp build\n```\n\nThe build task creates a `./dist` folder with all scripts and stylesheets concatenated, minified, and versioned, also third party libraries installed with bower will be concatenated and minified into `vendors.min.js` and `vendors.min.css` respectively.\n\nTo test the build version of the app, execute:\n\n```bash\ngulp serve:dist\n```\n\nThis task executes a build, then serves the /dist directory from the same port as the `gulp serve` task, http://127.0.0.1:3001/\n\n## Pulling Updates\nAs the civic-client is under heavy development, we'll be pushing releases to the master branch at a fairly rapid rate. Often, we'll update various packages and modules that are part of the workflow and/or production codebase. So after you do a `git pull` to update your local repository, be sure to:\n\n```bash\nyarn install\nbower install\n```\n\nThis will install any new packages or modules that the new updates require.\n\n## Related resources\n* [Personalized Cancer Therapy Knowledge Base for Precision Oncology (MD Anderson Cancer Center)](https://pct.mdanderson.org/)\n* [My Cancer Genome - Genetically Informed Cancer Medicine (Vanderbilt-Ingram Cancer Center)](http://www.mycancergenome.org/)\n* [Targeted Cancer Care (Massachusetts General Hospital)](https://targetedcancercare.massgeneral.org/My-Trial-Guide/Mutations.aspx)\n\n## Screenshots\n**Homepage:**\n![Homepage](notes/screenshots/home-view.png)\n\n**Browse Genes in the CIViC database:**\n![Homepage](notes/screenshots/gene-browse-view.png)\n\n**View an Evidence Item:**\n![Homepage](notes/screenshots/gene-variant-evidence-view.png)\n\n**Edit a Gene:**\n![Homepage](notes/screenshots/gene-edit-view.png)\n\n**View and comment on revisions to Genes, Variants, Evidence Items:**\n![Homepage](notes/screenshots/revision-view.png)\n\n**Catch up with recent CIViC activity:**\n![Homepage](notes/screenshots/activity-view.png)\n\n**Community leaderboards and user directory:**\n![Homepage](notes/screenshots/community-view.png)\n\n### Git repositories related to the CIViC project\nThe CIViC source code and application are organized in a client-server model. The backend code is available in the [civic-server repository](https://github.com/genome/civic-server) and frontend code is available in the [civic-client repository](https://github.com/genome/civic-client). Issues relating to curation are tracked in the [civic-curation repository](https://github.com/genome/civic-curation). An example of a Python client is available in the [civic-api-client repository](https://github.com/griffithlab/civic-api-client). Issues relating to public CIViC meetings are tracked in the [civic-meeting repository](https://github.com/genome/civic-meeting).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriffithlab%2Fcivic-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgriffithlab%2Fcivic-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriffithlab%2Fcivic-client/lists"}