This is an automated email from the ASF dual-hosted git repository. machristie pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/airavata-cookiecutter-django-output-view.git
commit 1dee5ea41b38c2844bf6aec523b1475dd41664e2 Author: Marcus Christie <[email protected]> AuthorDate: Wed Jun 2 11:34:54 2021 -0400 adding quickstart to README --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 515c7a5..f9761f8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,29 @@ - # Airavata Django Portal Output View Provider Cookiecutter ## Quickstart +Install the latest Cookiecutter if you haven't installed it yet: + + pip install --user -U cookiecutter + +This cookiecutter assumes that you are running it inside the root directory of a +custom Airavata Django app. If you don't yet have a custom Airavata Django app, +there is a cookiecutter you can use to create one: +https://github.com/machristie/cookiecutter-airavata-django-app. + +Once you have your custom Airavata Django app, go into the root directory and +run this cookiecutter there. For example, if you created an Airavata Django app +with the name `test_django_app`, then change to that directory (this is the +directory that contains the `setup.cfg` file) + + cd path/to/test_django_app + +Then run the following: - cd custom_django_app/custom_django_app/ cookiecutter https://github.com/machristie/cookiecutter-airavata-django-output-view.git -f -`-f` is needed because output_views/ directory should already exist +`-f` is needed because `output_views/` directory should already exist. + +When prompted for the name of the `custom_django_app_module_name`, give it the +name of your Airavata Django app. Keeping with the example, you would supply +`test_django_app`.
