bcgov / workforce-profile-tool

Workforce Profile tool
Apache License 2.0
5 stars 3 forks source link

Operational + project documentation #72

Open hangler opened 3 years ago

hangler commented 3 years ago

Add operational documentation to describe the administrative workflow. Add project documentation to aid future development arcs.

hangler commented 3 years ago

Hi @stephanieyurchak, please try to set up and run the project using the instructions here — I just tested in Windows and it works for me!

FYI @karmour

hangler commented 3 years ago

I should also note that most of the code / components could still use some comments; I'll be adding those in in the next few days.

karmour commented 3 years ago

Thanks Frank!

stephanieyurchak commented 3 years ago

@hangler I was able to get it to run locally following your instructions!

hangler commented 3 years ago

@stephanieyurchak Excellent! Glad to hear it and I trust it was relatively painless. I'll leave this ticket open until I've done more code documentation.

robinwn commented 3 years ago

@hangler - is there a sass dependancy that I'm missing?

./src/Core/App.scss (./.yarn/$$virtual/css-loader-virtual-d3681975f5/0/cache/css-loader-npm-4.3.0-33464197c9-1f441ac567.zip/node_modules/css-loader/dist/cjs.js??ref--5-oneOf-6-1!./.yarn/cache/postcss-loader-npm-3.0.0-f4ab99b685-50b2d8892d.zip/node_modules/postcss-loader/src??postcss!./.yarn/cache/resolve-url-loader-npm-3.1.2-38e8927e94-f7130c22b6.zip/node_modules/resolve-url-loader??ref--5-oneOf-6-3!./.yarn/$$virtual/sass-loader-virtual-ef12262451/0/cache/sass-loader-npm-8.0.2-f0d209ad64-e23d9b308f.zip/node_modules/sass-loader/dist/cjs.js??ref--5-oneOf-6-4!./src/Core/App.scss)
SassError: File to import not found or unreadable: C:\data\GitHub\workforce-profile-tool\.yarn\$$virtual\@bcgov-bootstrap-theme-virtual-35dbbaaffe\0\cache\@bcgov-bootstrap-theme-https-8b7bec3c7d-2e4a89b7b3.zip\node_modules\@bcgov\bootstrap-theme\dist\scss\bootstrap-theme.scss.
        on line 3 of src/_common.scss
        from line 1 of C:\data\GitHub\workforce-profile-tool\src\Core\App.scss
>> @import "~@bcgov/bootstrap-theme/dist/scss/bootstrap-theme";

   ^
This error occurred during the build time and cannot be dismissed.
hangler commented 3 years ago

@robinwn Hmm, @bcgov/bootstrap-theme is listed in devDependencies but it perhaps should be in the regular dependencies. How are you encountering this error? (And why would it not be occurring in the Github Actions build...?)

robinwn commented 3 years ago

repeated the whole process, and this time it worked. Only difference, did 'yarn set version latest' rather than 'yarn set version berry'; oh, and from a cmd prompt rather than from terminal inside VSCode. nb. Windows doesn't like the 'git rev-parse' in '"start": "REACT_APP_GIT_SHA=git rev-parse --short HEAD react-scripts start"', what with backquotes being a unix shell kind of thing.