Open laurianvm opened 6 months ago
agree, the goal should be to document high up in the README.md the usage of
curl -sL https://raw.githubusercontent.com/vliz-be-opsci/kgap/main/kgap-init | bash
in fact, additionally, provided we have the proper linking under the website publication setup correctly that should become:
curl -sL https://open-science.vliz.be/kgap/kgap-init | bash
additionally it could create boilerplate folders and some useful typical content:
./data ./config ./notebooks/requirements.txt .gitignore .env docker-compose.yml
also: think it is smart to have this script suggest using a project-specific REPO_NAME inside graphdb -- so that not everyone is using the kgap default there
relating to the boilerplate folders & their useful typical content --> listing all 'allowed' content would be handy for practical usage and could serve as 'how to'-documentation within kgap projects e.g. all possible/allowed task descriptions in the sembench.yaml
It would be useful to be able to initialize new k-gap project by running some script that clones this repository & asks some questions to set up the project context:
similarly to how npm init runs; e.g. by adding '| bash' to a command (as used in marc's dotfiles)