Installation

Requirements and Preparation

  • Ensure that python3.11 installed. Verify that typing ‘python’ gives you python3.11. If it doesn’t, make sure that your PATH is up-to-date.

    • Python is installed automatically using brew on MacOS if not present, using the steps in this document.

Installation

  1. Log into the user on the web provider and move the hosting directory into a different directory; we will be replacing it. In this case our directory is demo.plantracer.com:

    $ mv demo.planttracer.com demo-old

  2. Clone the planttracer web app into the hosting directory, for example demo.planttracer.com:

    $ git clone --recurse-submodules https://github.com/Plant-Tracer/webapp.git demo.planttracer.com

  3. Change to the local repository directory:

    $ cd demo.planttracer.com

  4. Make Python Virtual Environment (venv):

    $ make venv

  5. Activate the venv:

    $ . venv/bin/activate

  6. Install the prerequisites with make install-<your-os>, e.g.:

    $ make install-ubuntu

  7. Copy etc/credential_template.ini to etc/credentials.ini and fill in the fields for [client], [dbreader] and [`dbwriter].

    • Do not add any other .ini files to the repo. etc/credentials.ini is blocked by the .gitignore file, but it can be overridden.

  8. Create DynamoDB tables with a demo- prefix for demos and testing:

    $ make make-local-demo

  9. Run the self-tests:

    $ PLANTTRACER_CREDENTIALS=etc/credentials.ini make pytest-quiet

  10. Create your first course! If you want, give it a demo account too:

    $ PLANTTRACER_CREDENTIALS=etc/credentials.ini python dbutil.py --create_course "My Course Name" --course_id "Plant101" --admin_email your_admin_email@company.com --admin_name "Your Name"
course_key: leact-skio-proih

  11. You now have a course key!

  12. In order run a non-demo instance, a mailer must be configured in the credentials ini file, for example:

    [smtp]
SMTP_USERNAME=plantadmin@mycompany.com
SMTP_PASSWORD=MyPassword
SMTP_PORT=587
SMTP_HOST=smtp.mycompany.com

[imap]
IMAP_USERNAME=plantadmin@mycompany.com
IMAP_PASSWORD=MyPassword
IMAP_HOST=imap.mycompany.com
IMAP_PORT=993

Push to Lambda

cd gits/webapp
source venv/bin/activate
zappa status dev
make update-dev

  • If this is the first time the zappa function was published, update the DNS to point to the new API Gateway URL.

    For example, this zappa status dev shows that dev.planttracer.com should be a CNAME for uga7dh2bxj.execute-api.us-east-1.amazonaws.com.

API Gateway URL:      https://uga7dh2bxj.execute-api.us-east-1.amazonaws.com/dev
Domain URL:           https://dev.planttracer.com