Developer notes

1. Building for development
2. Install NPM to build the web application
   1. Install the web application dependancies
   2. Building the client
   3. Deploying the client
3. Testing
   1. Initial run
   2. After initializing metadata
4. Contributor Covenant Code of Conduct
   1. Our Pledge
   2. Our Standards
   3. Enforcement Responsibilities
   4. Scope
   5. Enforcement
   6. Enforcement Guidelines
      1. 1. Correction
      2. 2. Warning
      3. 3. Temporary Ban
      4. 4. Permanent Ban
   7. Attribution

Building for development

The client JavaScript application is built using NPM and may be deployed to the STATIC_ROOT file location using the Django management command (see Django settings).

Install NPM to build the web application

https://www.npmjs.com/get-npm

Install the web application dependancies

$ npm install

Building the client

This has been tested with node v12.13.0, npm v6.13.0.

cd reports/static
npm install
npm run build

Output is a set of bundle.<sha_hash>.js files created by the webpack bundler.

Deploying the client

TODO remove this section: superceded by pending client installation instructions from release bundle

• Note: this step is not needed in development when using the built in Django server, e.g.: ./manage.py runserver, static files will be served directly by the server.
• The Django collectstatic command assists in the moving the static web application files to the STATIC_ROOT file location:

cd <project_root>
./manage.py collectstatic --noinput --clear --ignore="*node_modules*" --ignore="*api_init*" --ignore="webpack*"

Testing

Screensaver tests are run using the Django management test command. Tests subclass django.test.TestCase, a subclass of unittest.TestCase that wraps each test, and each test class, in a transaction. See the Django documentation Writing and running tests for more information.

The Screensaver test suite requires a PostgreSQL database instance; this test database instance will be created when tests are run. The name of the test database is formed by prepending test_ to the NAME given in the DATABASES section of settings.py, e.g test_screensaver.

Initial run

Before the tests are run, the application metadata must be initialized. This step is built in to the test suite setupModule function and can be optionally turned on with the --reinit_metahash flag.

• --reinit_metahash should be used for the initial setup of the test database, or whenever the application metadata have been changed.
• See Bootstrapping metadata for more information.

# use the --reinit_metahash flag for the initial run
# use the --keepdb flag so that the metadata will be kept
manage.py test --reinit_metahash --keepdb

# run a single test with the --reinit_metahash flag, to reduce the time for the initial run
manage.py test db.test.tests.ScreenResource.test1_create_screen --reinit_metahash --keepdb 

After initializing metadata

manage.py test --keepdb

# run a single test
manage.py test db.test.tests.ScreenResource.test1_create_screen --keepdb

Contributor Covenant Code of Conduct

Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Our Standards

Examples of behavior that contributes to a positive environment for our community include:

• Demonstrating empathy and kindness toward other people
• Being respectful of differing opinions, viewpoints, and experiences
• Giving and gracefully accepting constructive feedback
• Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
• Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

• The use of sexualized language or imagery, and sexual attention or advances of any kind
• Trolling, insulting or derogatory comments, and personal or political attacks
• Public or private harassment
• Publishing others’ private information, such as a physical or email address, without their explicit permission
• Other conduct which could reasonably be considered inappropriate in a professional setting

Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ICCB-Longwood Screening Facility. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

1. Correction

Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

2. Warning

Community Impact: A violation through a single incident or series of actions.

Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

3. Temporary Ban

Community Impact: A serious violation of community standards, including sustained inappropriate behavior.

Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

4. Permanent Ban

Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

Consequence: A permanent ban from any sort of public interaction within the community.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.