QualOpt

QualOpt is a platform for software engineering researchers to manage invitations for their qualitative research studies and find participants from a set of GitHub users. The goal of this is to address the issue of GitHub users receiving too many unsolicited survey invitations. We do this by providing a centralized location for researchers to find GitHub users and providing a central place for GitHub users to manage how many invitations they receive.

For Researchers

Researchers can use this application to send out survey invitations in moderation. You can create a study on the application, with details of your survey and draft the email to be sent to your participants. Additionally, you can filter the participants who will receive the survey invitations using information from GitHub. This is great if you want easy contact to a tailored set of willing participants for your surveys.

For GitHub Users

GitHub users will be able to use this app to moderate the number of survey invitations they recieve. You will also have the benefit of being able to customise the types of surveys they recieve invitations for. We care about your privacy, so you're only giving out your email address to those who you want to see it.

Server-side code is located in /src/main/java/org/project36/qualopt/
Client-side code is located in /src/main/webapp/
All documentation is localed in the /docs/ directory
HTML mockups are stored in the /mockups/ directory

This application was generated using JHipster 4.6.2, you can find documentation and help at https://jhipster.github.io/documentation-archive/v4.6.2.

Development

Installation

Before you can build this project, you must install and configure the following dependencies on your machine:

Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.
Yarn: We use Yarn to manage Node dependencies. Depending on your system, you can install Yarn either from source or as a pre-packaged bundle.

Warning QualOpt cannot be run on Java 7 or earlier. The supported versions of Java are 8 and 9.

After installing Node, you should be able to run the following command to install development tools (try npm install if you have problems). You will only need to run this command when dependencies change in package.json.

yarn install

We use yarn scripts and Webpack as our build system.

Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.

./mvnw [just mvnw on cmd environments]
yarn start

Yarn is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run yarn update and yarn install to manage dependencies. Add the help flag on any command to see how you can use it. For example, yarn help update.

The yarn run command will list all of the scripts available to run for this project.

Service workers

Service workers are commented by default, to enable them please uncomment the following code.

The service worker registering script in index.html

<script>
if ('serviceWorker' in navigator) {
    navigator.serviceWorker
    .register('./sw.js')
    .then(function() { console.log('Service Worker Registered'); });
}
</script>

The copy file option in webpack-common.js
```
{ from: './src/main/webapp/sw.js', to: 'sw.js' },
```
Note: Add the respective scripts/assets in sw.js that is needed to be cached.

Managing dependencies

For example, to add Leaflet library as a runtime dependency of your application, you would run following command:

yarn add --exact leaflet

To benefit from TypeScript type definitions from DefinitelyTyped repository in development, you would run following command:

yarn add --dev --exact @types/leaflet

Then you would import the JS and CSS files specified in library's installation instructions so that Webpack knows about them:

Edit src/main/webapp/app/vendor.ts file:

import 'leaflet/dist/leaflet.js';

Edit src/main/webapp/content/css/vendor.css file:

@import '~leaflet/dist/leaflet.css';

Note: there are still few other things remaining to do for Leaflet that we won't detail here.

For further instructions on how to develop with JHipster, have a look at Using JHipster in development.

Using angular-cli

You can also use Angular CLI to generate some custom client code.

For example, the following command:

ng generate component my-component

will generate few files:

create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts

Building for production

To optimize the QualOpt application for production, run:

./mvnw -Pprod clean package

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:

java -jar target/*.war

Then navigate to http://localhost:8080 in your browser.

Refer to Using JHipster in production for more details.

Testing

To launch your application's tests, run:

./mvnw clean test

Client tests

Unit tests are run by Karma and written with Jasmine. They're located in src/test/javascript/ and can be run with:

yarn test

For more information, refer to the Running tests page.

Using Docker to simplify development (optional, we currently use Heroku for web hosting http://www.jhipster.tech/heroku/)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services. For example, to start a mysql database in a docker container, run:

docker-compose -f src/main/docker/mysql.yml up -d

To stop it and remove the container, run:

docker-compose -f src/main/docker/mysql.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

./mvnw package -Pprod docker:build

Then run:

docker-compose -f src/main/docker/app.yml up -d

For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.

Continuous Integration (optional, not currently implemented)

To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.

kblincoe / QualOpt_SE701

readme