Skip to content

Latest commit

 

History

History
138 lines (86 loc) · 6.3 KB

README.md

File metadata and controls

138 lines (86 loc) · 6.3 KB
Raw
Twilio

Appointment Reminders with Java

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 and we'll try to help you.

About

This sample application demonstrates how to send appointment reminders to customers when they have an upcoming appointment.

Read the full tutorial here!

Implementations in other languages:

.NET Python Ruby PHP Node
Done Done Done Done Done

Set up

Requirements

Twilio Account Settings

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:

Config Value Description
Account Sid Your primary Twilio account identifier - find this in the Console.
Auth Token Used to authenticate - just like the above, you'll find this here.
Phone number A Twilio phone number in E.164 format - you can get one here

Local development

After the above requirements have been met:

  1. Clone this repository and cd into it

    git clone [email protected]:TwilioDevEd/appointment-reminders-java.git
cd appointment-reminders-java

  2. Set your environment variables

    cp .env.example .env

    See Twilio Account Settings to locate the necessary environment variables.

    If you are using a UNIX operating system, load the environment variables before the application starts.

    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.

  3. The database schema is managed using Flyway. Execute its migrations with:

    mvn flyway:migrate

  4. Run the application with scheduler.

    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

That's it!

Docker

If you have Docker 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.
  3. Run docker-compose --env-file /dev/null up.

Tests

You can run the tests locally by typing:

mvn compile test

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 Deploy

Some notes:

  • For Heroku, please check this to properly configure the project for deployment.
  • You can also follow this guide to deploy the application to several other cloud services including Google Cloud, Oracle Cloud, etc.

Resources

  • The CodeExchange repository can be found here.

Contributing

This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.