IQSS / dataverse-frontend

An upcoming and modernized UI for Dataverse
Apache License 2.0
20 stars 16 forks source link

471: update the DEVELOPER_GUIDE.md instructions for running locally #527

Closed ekraffmiller closed 1 month ago

ekraffmiller commented 1 month ago

What this PR does / why we need it:

Adds instructions for updating .env with S3 Credentials, and description of the 'unstable' tag.

Which issue(s) this PR closes:

Special notes for your reviewer:

I'm not sure what this meant from the issue description:

We can also include a more friendly way to setup the environment, by simply running ./run-env.sh unstable without having to worry so much about the images and container registries.

So I added more descriptive text, is there more that should be done?

Suggestions on how to test this:

Review the README and check the steps for local setup

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No

Is there a release notes update needed for this change?:

No

Additional documentation:

coveralls commented 1 month ago

Coverage Status

coverage: 97.455% (+0.3%) from 97.181% when pulling f9375cde751da2758bbc096e4c44d9910bfd5743 on fix/471-update-readme into 31c2d49df90a1ab14f32c5f1e6b8922532db5fea on develop.

ofahimIQSS commented 1 month ago

Verified and ensured text looks good without spelling errors