Test ci

.dockerignore

@@ -0,0 +1,5 @@
+bin/
+build/
+*.db
+*.sqlite
+.env

.github/workflows/maven.yml

@@ -0,0 +1,34 @@
+# This workflow will build a Java project with Maven
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Java
+
+on:
+  push:
+    branches: [ master, next ]
+  pull_request:
+    branches: [ master, next ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      max-parallel: 3
+      matrix:
+        platform: [windows-latest, macos-latest, ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 11
+      uses: actions/setup-java@v1
+      with:
+        java-version: 11.0
+    - name: Build with Maven
+      run: mvn compile
+    - name: Test
+      run: mvn clean test
+      env:
+        TWILIO_ACCOUNT_SID: ACXXXXXXXX
+        TWILIO_AUTH_TOKEN: xxxxxxxxxx
+        VERIFICATION_SID: VAxxxxxxxx

.gitignore

@@ -5,4 +5,9 @@ target/*
 
 .env
 
-*.sqlite
+*.sqlite
+
+.classpath
+.project
+.settings
+bin

.mergify.yml

@@ -0,0 +1,10 @@
+pull_request_rules:
+  - name: automatic merge for Dependabot pull requests
+    conditions:
+      - author=dependabot-preview[bot]
+      - status-success=build (macos-latest)
+      - status-success=build (windows-latest)
+      - status-success=build (ubuntu-latest)
+    actions:
+      merge:
+        method: squash

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at open-source@twilio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing to Twilio
+
+All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

Dockerfile

@@ -0,0 +1,15 @@
+FROM maven:3-openjdk-11
+
+WORKDIR /usr/app/
+
+RUN apt-get update && \
+  apt-get upgrade -y && \
+  apt-get install -y build-essential
+
+COPY . .
+
+RUN make install
+
+EXPOSE 8080
+
+CMD ["make", "serve"]

LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2019 Twilio Inc.
+Copyright (c) 2020 Twilio Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,5 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+SOFTWARE.

Makefile

@@ -0,0 +1,8 @@
+.PHONY: install serve
+
+install:
+	mvn compile flyway:migrate
+	mvn compile
+
+serve:
+	mvn compile jetty:run

README.md

@@ -1,60 +1,137 @@
+<a  href="https://www.twilio.com">
+<img  src="https://static0.twilio.com/marketing/bundles/marketing/img/logos/wordmark-red.svg"  alt="Twilio"  width="250"  />
+</a>
+
+# Twilio Verify Quickstart with Java servlets
+
+![](https://github.com/TwilioDevEd/verify-v2-quickstart-java/workflows/Java/badge.svg)
+
 > We are currently in the process of updating this sample template. If you are encountering any issues with the sample, please open an issue at [github.com/twilio-labs/code-exchange/issues](https://github.com/twilio-labs/code-exchange/issues) and we'll try to help you.
 
+## About
 
 This application example demonstrates how to Simple phone verification with Java,
 Servlets, and Twilio Verify.
 
-## Local Development
+Implementations in other languages:
+
+| .NET | Python | Ruby | PHP | Node |
+| :--- | :--- | :----- | :-- | :--- |
+| [Done](https://github.com/TwilioDevEd/verify-v2-quickstart-csharp) | [Done](https://github.com/TwilioDevEd/verify-v2-quickstart-python)  | [Done](https://github.com/TwilioDevEd/verify-v2-quickstart-rails)    | [Done](https://github.com/TwilioDevEd/verify-v2-quickstart-php) | [Done](https://github.com/TwilioDevEd/verify-v2-quickstart-node)  |
+
+<!--
+### How it works
+
+**TODO: Describe how it works**
+-->
+
+## Set up
+
+### Requirements
+
+- [Java Development Kit](https://adoptopenjdk.net/) version 11 or later.
+- A Twilio account - [sign up](https://www.twilio.com/try-twilio)
+
+### Twilio Account Settings
 
-1. First clone this repository and `cd`into it.
+This application should give you a ready-made starting point for writing your
+own appointment reminder application. Before we begin, we need to collect
+all the config values we need to run the application:
 
-   ```bash
-   $ git clone git@github.com:TwilioDevEd/verify-v2-quickstart-java.git
-   $ cd verify-v2-quickstart-java
-   ```
+| Config&nbsp;Value | Description                                                                                                                                                  |
+| :---------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Account&nbsp;Sid  | Your primary Twilio account identifier - find this [in the Console](https://www.twilio.com/console).                                                         |
+| Auth&nbsp;Token   | Used to authenticate - [just like the above, you'll find this here](https://www.twilio.com/console).                                                         |
+| Verification&nbsp;Sid |  For Verification Service SID. You can generate one [here](https://www.twilio.com/console/verify/services) |
 
-1. Copy the sample configuration file and edit it to match your configuration.
+### Local development
+
+After the above requirements have been met:
+
+1. Clone this repository and `cd` into it
 
     ```bash
-    $ cp .env.example .env
+    git clone git@github.com:TwilioDevEd/verify-v2-quickstart-java.git
+    cd verify-v2-quickstart-java
     ```
 
-   You'll need to set your `TWILIO_ACCOUNT_SID` and `TWILIO_AUTH_TOKEN` from the
-   [Twilio Console](https://www.twilio.com/console). Also create a new verification
-    service [here](https://www.twilio.com/console/verify/services) and set the 
-    service `VERIFICATION_SID` in your `.env`.
+2. Set your environment variables
+
+    ```bash
+    cp .env.example .env
+    ```
+    See [Twilio Account Settings](#twilio-account-settings) to locate the necessary environment variables.
 
-   Once you have populated all the values, load the variables with `source`.
+    If you are using a UNIX operating system, load the environment variables before the application starts.
 
     ```bash
-    $ source .env
+    source .env
     ```
 
-    _If you are using a different operating system, make sure that all the variables
-     from the `.env` file are loaded into your environment._
+    _If you are using a different operating system, make sure that all the variables from the `.env` file are loaded into your environment._
 
-1. Execute the migrations.
+3. Build the project
 
-   ```bash
-   $ mvn compile flyway:migrate
-   ```
+    ```bash
+    make install
+    ```
+    **NOTE:** Running the build task will also run the tests
 
-1. Run the application.
-   ```bash
-   $ mvn compile jetty:run
-   ```
+4. Run the application
 
-1. Check it out at [http://localhost:8080/](http://localhost:8080/)
+    ```bash
+    make serve
+    ```
+    **NOTE:** If you are using a dedicated Java IDE like Eclipse or IntelliJ, you can start the application within the IDE and it will start in development mode, which means any changes on a source file will be automatically reloaded.
 
+5. Navigate to [http://localhost:8080](http://localhost:8080)
 
-## Run the tests
+That's it!
 
-```
+### Docker
+
+If you have [Docker](https://www.docker.com/) already installed on your machine, you can use our `docker-compose.yml` to setup your project.
+
+1. Make sure you have the project cloned.
+2. Setup the environmental variables in the `docker-compose.yml` file, see the [Twilio Account Settings](#twilio-account-settings).
+3. Run `docker-compose --env-file /dev/null up`.
+
+### Tests
+
+You can run the tests locally by typing:
+
+```bash
 mvn clean test
 ```
 
-## Meta
+### Cloud deployment
+
+Additionally to trying out this application locally, you can deploy it to a variety of host services. Here is a small selection of them.
+
+Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.
+
+| Service                           |                                                                                                                                                                                                                           |
+| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [Heroku](https://www.heroku.com/) | [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/TwilioDevEd/verify-v2-quickstart-java/tree/master)                                                                                                                                       |
+
+**Some notes:** 
+- For Heroku, please [check this](https://devcenter.heroku.com/articles/deploying-gradle-apps-on-heroku) to properly configure the project for deployment.
+- You can also follow [this guide](https://vaadin.com/blog/how-to-deploy-your-java-app-to-the-cloud) to deploy the application to several other cloud services including Google Cloud, Oracle Cloud, etc.
+
+## Resources
+
+- The CodeExchange repository can be found [here](https://github.com/twilio-labs/code-exchange/).
+
+## Contributing
+
+This template is open source and welcomes contributions. All contributions are subject to our [Code of Conduct](https://github.com/twilio-labs/.github/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+[MIT](http://www.opensource.org/licenses/mit-license.html)
+
+## Disclaimer
+
+No warranty expressed or implied. Software is as is.
 
-* No warranty expressed or implied. Software is as is. Diggity.
-* [MIT License](http://www.opensource.org/licenses/mit-license.html)
-* Lovingly crafted by Twilio Developer Education.
+[twilio]: https://www.twilio.com

docker-compose.yml

@@ -0,0 +1,12 @@
+version: "3.6"
+services:
+  app:
+    stdin_open: true
+    tty: true
+    environment:
+      - TWILIO_ACCOUNT_SID=your_account_sid
+      - TWILIO_AUTH_TOKEN=your_account_token
+      - VERIFICATION_SID=VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+    build: .
+    ports: 
+      - "8080:8080"