Skip to content

Commit

Permalink
Merge branch 'main' into release
Browse files Browse the repository at this point in the history
  • Loading branch information
acoffman committed May 3, 2022
2 parents b2c7722 + 246f50d commit 68d66ad
Show file tree
Hide file tree
Showing 200 changed files with 7,013 additions and 2,967 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/build_frontend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ jobs:
- run: bundle exec rails assets:precompile
working-directory: ./server

- if: ${{ inputs.branch == 'staging' }}
run: mv -f lib/assets/favicon.staging.ico public/favicon.ico
working-directory: ./server

- name: Commit and push build
uses: EndBug/add-and-commit@v7
with:
Expand Down
53 changes: 15 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,52 +9,29 @@ The CIViC knowledgebase project seeks to advance cancer precision medicine with
All content created in CIViC is, and will continue to be, freely available, without restriction with a Public Domain License. Anyone can contribute to CIViC by simply registering for an account. Users join the community with “Curator” level privileges that allow them to comment or propose additions or revisions on any knowledge in CIViC. Proposed additions and revisions are then reviewed by users with “Editor” level privileges before gaining “Accepted” status. Submitted content, not yet accepted, should be interpreted/used with caution. Community Curators work together with Editors towards comprehensive and accurate interpretations of the clinical relevance of variants in cancer.

## Getting Started

CIViC is a Rails backend serving a GraphQL API to an Angular frontend. The same API that powers the frontend is available for anyone to use. The easiest way to get started is to experiment in the [GraphiQL user interface](https://civicdb.org/api/graphiql). You can also browse autogenerated documentation [here](https://griffithlab.github.io/civic-v2/).
### Dependencies

* Describe any prerequisites, libraries, OS version, etc., needed before installing program.
* ex. Windows 10
* Ruby >= 3.0 (recomended install via rbenv)
* PostgreSQL >= 14
* Node >= 14

### Installing

* How/where to download your program
* Any modifications needed to be made to files/folders

### Executing program

* How to run the program
* Step-by-step bullets
```
code blocks for commands
```

## Help

Any advise for common problems or issues.
```
command to run if program contains helper info
```
* In `server/`
* `gem install bundler && rbenv rehash`
* `bundle install`
* `rails db:create`
* `rails db:schema:load`
* `rails s` to start the server. It will be running on `127.0.0.1:3000`.

## Authors

Contributors names and contact info

ex. Software Developer
ex. [@CivicContributor](https://twitter.com/civiccontributor)
* In `client/`
* `npm install -g yarn`
* `yarn install`
* `yarn start` will start the dev server at `127.0.0.1:4200` and proxy API requests to the backend

## Version History

* 0.2
* Various bug fixes and optimizations
* See [commit change]() or See [release history]()
* 0.1
* Initial Release
[See Releases Page](https://github.com/griffithlab/civic-v2/releases)

## License

The content of CIViC, hosted by [The McDonnell Genome Institute at Washington University School of Medicine](http://genome.wustl.edu/) is released under the [Creative Commons Public Domain Dedication (CC0 1.0 Universal)](https://creativecommons.org/publicdomain/zero/1.0/) and the source code for the CIViC server and client is licensed under the [MIT License](http://opensource.org/licenses/MIT).

## Acknowledgments

Inspiration, code snippets, etc.
* [awesome-readme](https://github.com/matiassingers/awesome-readme)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Component, TemplateRef } from '@angular/core';
import { ChangeDetectionStrategy, Component, TemplateRef } from '@angular/core';
import { Clipboard } from '@angular/cdk/clipboard';
import { NetworkErrorsService } from '@app/core/services/network-errors.service';
import { NzModalRef, NzModalService } from 'ng-zorro-antd/modal';
Expand All @@ -7,6 +7,7 @@ import { NzModalRef, NzModalService } from 'ng-zorro-antd/modal';
selector: 'cvc-network-error-alert',
templateUrl: './network-error-alert.component.html',
styleUrls: ['./network-error-alert.component.less'],
changeDetection: ChangeDetectionStrategy.OnPush
})
export class CvcNetworkErrorAlertComponent {
errors: NetworkErrorsService;
Expand Down
Loading

0 comments on commit 68d66ad

Please sign in to comment.