Open smalers opened 3 years ago
Josh updated the application. Here are my comments on a second pull after the initial setup, in case this is useful for developer documentation.
.npmrc
and package-lock.json
.git-pull
complains that local changes to package-lock.json
are in conflict. I removed local changes with git checkout -- package-lock.json
. Then pull again..npmrc
to exist locally because no additional changes have occurred on the remote but if there were remote changes I'd have to do a merge or re-setup again.npm install
to get the latest OpenWaterFoundation/common
library version, right? Before doing that, try ng serve
to see what happens. The application starts OK and images are shown, but not sure if the recent library code is being used.npm install
. Warnings are shown but it is not obvious that the OWF library is updated. Maybe just need to recommend that any time the repo is pulled that npm install
is also run.
Here are my notes installing and running the SNODAS application. This can be used to improve the development environment, in particular for someone like me that is trying to do basic review and provide feedback.
README.md
. It needs to be implemented as a combination of original README, Jessica's README, and similar to InfoMapper, in order to facilitate a new developer getting set up. I suppose we'll need to agree on recommended folder names..gitignore
. This should perhaps always exist and can have a comment inside mentioning the other.gitignore
. Definitely need to list in theREADME.md
.ng-workspace
. Then every repo would have the same top-level folder and that folder would indicate the development environment. For example, I useeclipse-workspace
andmkdocs-projects
similarly in other repos. Thoughts? Would there every be the case that more than one workspace exists in the same repo?README.md
files in various folders, even if very short, to explain the contents of the folder. The mainREADME.md
can have the more comprehensive repository structure explanation. I do see a few readme files.app-snodas
,lib-owf-common
,lib-owf-plotly
so that it is very clear when a project is an application and when a library?ng serve
in. That should be explained in a Running the Application or similar section of the documentation.I tried running in the
snodas
folder and saw:Try:
Note sure what all the warnings are but hopefully they get cleared up. Need to set up access.
In the
snodas-workspace
folder add a.npmrc
file with the following.read:packages
checkbox. There should be no needed to delete or write packages and the average developer on the web would not have permissions to do that.Running
npm install
then shows:Change to
projects/snodas
and runng serve
. It displays the application.I recommend that these issue comments are used to improve the
README.md
. In particular:.npmrc
in the repository without accidentally publishing a person's token?npm install
to locate, download, and install GItHub packages that are hosted in Open Water Foundation library repositories...".