Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

startup tweaks and README additions (#512) #515

Merged
merged 3 commits into from
Nov 2, 2024

Conversation

artoonie
Copy link
Owner

@artoonie artoonie commented Nov 1, 2024

This pull request is the squashed forked pull request from slhudson:chore/readme (#512). It is needed to allow running the Heroku CI from forks. This workflow is a work-in-progress and I welcome other suggestions to get the Heroku fork to work. See details here: heroku/roadmap#322

--

  • adds packages needed on installation

  • create package-lock.json

  • moves the template .env file out of the README and into infra/

  • rearranges README

moves examples and oembed into the intro section, which is focused on users who don't want to clone the repo

consolidates movie details at the bottom so first-time users can focus on getting the server running

  • relabel README sections

  • creates script to get API key and store it in .env

(1) adds the API credentials and key to the .env.template

(2) creates get-api-key.sh (modeled after serve.sh) to request the API key and store it in .env

(3) modifies the README accordingly

  • adds some whitespace to README for readability

  • validates token based on length

as in testRestApiExampleCode.py

  • removes package-lock.json

I see now where these values are stored in package.json

  • adds .DS_store to .gitignore

  • adds a script to create a user for local, offline use

  • adds a script to create a user for local, offline use

  • README typo fixes

  • removes get-api-key.sh from this branch

  • Revert "Merge branch 'chore/readme' of https://github.com/slhudson/rcvis into chore/readme"

This reverts commit 4527891, reversing changes made to 57ee579.

  • Update README.md

  • Update infra/.env.template

  • Update infra/.env.template

  • remove HTML line breaks from README

  • remove API parameters from .env.template

  • Update requirements-core.txt

  • Remove recommendation to install postgresql

  • prompts the creation of an admin user in serve.sh

  • improves serve.sh comments

  • Update scripts/serve.sh


slhudson and others added 3 commits November 1, 2024 01:08
* adds packages needed on installation

* create package-lock.json

* moves the template .env file out of the README and into infra/

* rearranges README

moves examples and oembed into the intro section, which is focused on users who don't want to clone the repo

consolidates movie details at the bottom so first-time users can focus on getting the server running

* relabel README sections

* creates script to get API key and store it in .env

(1) adds the API credentials and key to the .env.template

(2) creates get-api-key.sh (modeled after serve.sh) to request the API key and store it in .env

(3) modifies the README accordingly

* adds some whitespace to README for readability

* validates token based on length

as in testRestApiExampleCode.py

* removes package-lock.json

I see now where these values are stored in package.json

* adds .DS_store to .gitignore

* adds a script to create a user for local, offline use

* adds a script to create a user for local, offline use

* README typo fixes

* removes get-api-key.sh from this branch

* Revert "Merge branch 'chore/readme' of https://github.com/slhudson/rcvis into chore/readme"

This reverts commit 4527891, reversing
changes made to 57ee579.

* Update README.md

Co-authored-by: Armin Samii <[email protected]>

* Update infra/.env.template

Co-authored-by: Armin Samii <[email protected]>

* Update infra/.env.template

Co-authored-by: Armin Samii <[email protected]>

* remove HTML line breaks from README

* remove API parameters from .env.template

* Update requirements-core.txt

* Remove recommendation to install postgresql

* prompts the creation of an admin user in serve.sh

* improves serve.sh comments

* Update scripts/serve.sh

---------

Co-authored-by: Armin Samii <[email protected]>
Copy link

codecov bot commented Nov 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.67%. Comparing base (23570b3) to head (ca5a79d).
Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #515      +/-   ##
==========================================
+ Coverage   87.86%   96.67%   +8.80%     
==========================================
  Files         116      121       +5     
  Lines        5086     5833     +747     
==========================================
+ Hits         4469     5639    +1170     
+ Misses        617      194     -423     
Files with missing lines Coverage Δ
electionpage/tests.py 100.00% <ø> (ø)

... and 22 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

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

@artoonie artoonie merged commit 67c378a into main Nov 2, 2024
8 checks passed
@artoonie artoonie deleted the fork/slhudson/chore/readme branch November 2, 2024 00:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants