startup tweaks and README additions (#512) #515
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
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