An emotion tracking web application which can be used by health practioners and their consumers. Provides ability for consumers to quickly log data about emotion and mood, and provides convenient, helpful links.
- Prerequisites
- Setup
- Running your project
- Deploying Project for Production
- Testing and Continuous Integration
- Authors
Versions used for required packages:
- OpenJDK v1.8.0_141
- Node v6.11.2
- Npm v3.10.10
- @angular/cli v1.0.0
- Yarn v1.0.2
- IntelliJ Gradle Plugin
For IntelliJ users, you should be able to clone this repository inside IntelliJ
- When prompted to create a new IntelliJ project, select yes.
- Select import project from existing model and select Gradle.
- Make sure Use default Gradle wrapper is selected.
- Click Finish.
- If IDEA asks you if you want to compile JavaScript to TypeScript 🔥 DO NOT 🔥 – if you do it will break your project.
gradle
, yarn
, and ng
) to do that compilation.
If you let IDEA do it, you'll
have a ton of JavaScript files cluttering up your project and confusing other
tools.
- The build task will build the entire project (but not run it)
- The run Gradle task will still run your SparkJava server.
(which is available at
localhost:4567
) - The runClient task will build and run the client side of your project (available at
localhost:9000
) - The runAllTests task will run both the Java (server) tests and the
karma
(client-side, Angular) tests - The runServerTests task will run the Java (server) tests
- The runClientTests task will run the
karma
(client-side, Angular) tests.- The runClientTestWithCoverage task will run the
karma
tests and generate test coverage data which will be placed inclient/coverage
; open theindex.html
in that directory in a browser and you'll get a web interface to that coverage data. - The runClientTestsAndWatch task will run the
karma
tests, but leave the testing browser open and the tests in "watch" mode. This means that any changes you make will cause the code to recompile and the tests to be re-run in the background. This can give you continuous feedback on the health of your tests.
- The runClientTestWithCoverage task will run the
- The runE2ETest task runs the E2E (end-to-end, Protractor) tests. For this to work you must make sure you have your server running, and you may need to re-seed the database to make sure it's in a predictable state.
- The seedMongoDB task will load the "demo" data into the Mongo database. If you want/need to change what gets loaded, the
seedMongoDB
command is defined in the top levelbuild.gradle
and currently loads four files,emotions.seed.json
,goals.seed.json
,resources.seed.json
, andjournals.seed.json
, all of which are also in the top level of the project. To load new/different data you should create the necessary JSON data files, and then updatebuild.gradle
to load those files.
build.sh is a script that calls upon gradle build to build the entire project which creates an executable to be able to launch the
project in production mode. To run build.sh, go to your project directory in a terminal and enter:./build.sh
When build.sh is run, the script .3601_run.sh is copied to ~/3601.sh. When this is launched, for example, ./3601.sh
, will run your project in production mode. The API_URL in environment.prod.ts needs to be
the actual URL of the server. If your server is deployed on a droplet or virtual machine, for example, then you want something like
http://192.168.0.1:4567
where you replace that IP with the IP of your droplet. If you've set up a domain name for your system, you can use that instead, like http://acooldomainname.com
.
Instructions on setting up the project for production can be found here: UMM CSCI 3601 Droplet Setup Instructions
Testing the client:
runAllTests
runs both the server tests and the clients tests once.runClientTests
runs the client tests once.runClientTestsAndWatch
runs the client tests every time that the code changes after a save.runClientTestsWithCoverage
runs the client tests and deposits code coverage statistics into a new directory withinclient
calledcoverage
. In there you will find anindex.html
. Right click onindex.html
and selectOpen in Browser
with your browser of choice. For Chrome users, you can drag and drop index.html onto chrome and it will open it.runE2ETest
runs end to end test for the client side. NOTE: Two Gradle tasks must be run before you can run the e2e tests. The server (run
) needs to be on for this test to work, and you have to need to have data in thedev
database before running the e2e tests!runServerTests
runs the server tests.
- Jubair Hassan
- Abenezer Monjor
- Hunter Welch
- Yukai Zang
- Sunjae Park