dockstore-ui2 icon indicating copy to clipboard operation
dockstore-ui2 copied to clipboard

Update README for devs

Open aofarrel opened this issue 2 years ago • 5 comments

Description This change is needed because I installed the wrong version of Angular seven times.

Issue N/A

Please make sure that you've checked the following before submitting your pull request. Thanks!

  • [x] Check that your code compiles by running npm run build
  • [x] If this is the first time you're submitting a PR or even if you just need a refresher, consider reviewing our style guide
  • [x] Do not bypass Angular sanitization (bypassSecurityTrustHtml, etc.), or justify why you need to do so
  • [x] If displaying markdown, use the markdown-wrapper component, which does extra sanitization
  • [x] Do not use cookies, although this may change in the future
  • [x] Run npm audit and ensure you are not introducing new vulnerabilities
  • [x] Do due diligence on new 3rd party libraries, checking for CVEs
  • [x] Don't allow user-uploaded images to be served from the Dockstore domain

aofarrel avatar Jun 15 '22 00:06 aofarrel

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

sonarqubecloud[bot] avatar Jun 15 '22 00:06 sonarqubecloud[bot]

As you may have noticed from the OS: darwin x64 line, I'm on a Mac, so the Angular output might need to be linuxafied.

aofarrel avatar Jun 15 '22 00:06 aofarrel

Codecov Report

Merging #1557 (9ab8ed0) into develop (4f79157) will decrease coverage by 0.01%. The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1557      +/-   ##
===========================================
- Coverage    43.89%   43.88%   -0.02%     
===========================================
  Files          312      312              
  Lines         9380     9380              
  Branches      2244     2244              
===========================================
- Hits          4117     4116       -1     
- Misses        3432     3433       +1     
  Partials      1831     1831              
Impacted Files Coverage Δ
...rc/app/home-page/home-logged-out/home.component.ts 68.57% <0.00%> (-2.86%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 4f79157...9ab8ed0. Read the comment docs.

codecov[bot] avatar Jun 15 '22 00:06 codecov[bot]

@coverbeck

But the whole global Angular thing was before we understood how to do things via package.json and a local Angular.

I'm getting the feeling I am not part of this "we" because what I put in this readme is what I actually did 🙃

It might be best to have someone who actually understands what is going on update this readme...

aofarrel avatar Jun 15 '22 18:06 aofarrel

@coverbeck

I'm getting the feeling I am not part of this "we" because what I put in this readme is what I actually did 🙃

I was referring the to the dev team at the time who worked on updating the package.json. No insult intended.

When you run npm run start, you are doing "npx ng serve --proxy-config=proxy.conf.json which doesn't use the global Angular. So although you installed the global Angular and things then worked, having the global Angular installed or not should be irrelevant.

coverbeck avatar Jun 15 '22 20:06 coverbeck

@coverbeck has since updated the readme, which I followed for a fresh installation with ease. It's much better than what I have in this PR.

aofarrel avatar Sep 13 '23 23:09 aofarrel