This is a Spring Boot Web Application to manage and schedule appointments between providers and customers. It has many features such as automatic invoicing, email notifications, appointments cancelation, providers individual working plans with brakes etc.
Improved and prod ready version of this app can be found at SpotASlot.com
The live demo of this repo (master branch) can be found here
You can use the following credentials with live demo:
| Account type | Username | Password |
|---|---|---|
admin |
admin | qwerty123 |
provider |
provider | qwerty123 |
corporate customer |
customer_c | qwerty123 |
retail customer |
customer_r | qwerty123 |
This application is being described in devoxify.com blog. If you are interested in how this project was created, what issues were encoutered and how they were solved I highly encourage you to visit this blog.
1. Clone the application
git clone https://github.com/slabiak/AppointmentScheduler.git2. Create MySQL database
create database appointmentscheduler- After that run MySQL script to create tables
src/main/resources/appointmentscheduler.sql
3. Configure enviroment variables
- open
src/main/resources/application.properties - set env variables for JDBC
dbURL,dbUsername,dbPassword - set env variables for mail server
mailUsername,mailPassword - set jwtSecret, encoded with Base64
jwtSecret
4. Run the app using maven
mvn spring-boot:runThe app will start running at http://localhost:8080
5. Login to admin account
- username:
admin - password:
qwerty123
admin - is created at database initialization. Admin can add new providers, services and assign services to providers. Admin can see list of all: appointments, providers, customers, invoices. He can also issue invoices manually for all confirmed appointments.
provider - can by created by admin only. Provider can set his own working plan, add brakes to that working plan and change his available services. Provider sees only his own appointments.
customer retail - registration page is public and can be created by everyone. Customer can only book new appointments and manage them. This type of customer sees only services which targets retail customer.
customer corporate - almost the same as retail customer. The only difference is that this type of account needs to provide VAT number and Company Name and can see only services which targets corporrate customer.
To book a new appointment customer needs to click New Appointment button on all appointments page and then:
- Choose desired work from available works list
- Choose provider for selected work
- Choose on of available date which is presented to him
- Click book on confirmation page
Available hours are calculatated with getAvailableHours function from AppointmentService:
List<TimePeroid> getAvailableHours(int providerId,int customerId, int workId, LocalDate date)
This function works as follow:
- gets selected provider working plan
- gets working hours from working plan for selected day
- excludes all brakes from working hours
- excludes all providers booked appointments for that day
- excludes all customers booked appointments for that day
- gets selected work duration and calculate available time peroids
- returns available hours
1. Every appointment has it's own status. Below you can find description for every possible status:
| Status | Set by | When | Condition |
|---|---|---|---|
scheudled |
system | New appointment is created | - |
finished |
system | Current date is after appointment end time | current appointment status is scheduled and current date is after appointment end time |
confirmed |
system | Current date is 24h after appointment end time | current appointment status is finished and current date is more than 24h after appointment end time |
invoiced |
system | Invoice for appointment is created | - |
canceled |
customer | Customer clicks cancel button | current appointment status is scheduled and current date is not less than 24h before appointment start time and user total canceled appointments number for current month is not greater than 1 |
rejection requested |
customer | Customer clicks reject button | current appointment status is finished and current date is not more than 24h after appointment end time |
rejection accepted |
provider | Provider clicks accept rejection button | current appointment status is rejection requested |
2. Normal appointment lifecycle is:
- scheduled - after user creates new appointment
- finished - after system time is after appointment end time
- confirmed - after system time is more than 24h after appointment end time and user didn't request rejection
- invoiced - after invoiced is issued automatically on the 1st day of next month
3. Appointment rejection
After appointment status is changed to finished system automatically sends email to customer with information that appointment is finished. In case that the appointment didn't take place there is also a link attached to that email that allows customer to reject that the appointment didn't take place. That link is valid for 24h after appointment finished time. If user will no click that link then appointment status will be automatically chaned to confirmed after 24h and invoiced at the 1st day of next month. If user will click that link an email is send to provider that his customer requested rejection. If provied will accept that rejection then appointment status will be changed to rejection accepted and appointment will be not invoiced.
4. Apppointment cancellation
Every appointment can be canceled by customer or provider. Customer is allowed to cancel 1 appointment in a month no less than 24h before appointment start date. Provider is allowed to cancel his appointments without any limit as long as the appointment status is scheduled.
1. An email notification is sent when:
- appointment is finished
- appointment rejection is rquested
- appointment rejection is accepted
- new appointment is created
- appointment is canceled
- invoice is issued
Email templates can be found here: src\main\resources\templates\email
- Fullcalendar - A JavaScript event calendar
- FlyingSaucer - Used to generate invoice PDF
- jjwt - Used to generate/validate JWT tokens
Let's together make AppointmentScheduler awesome!
If you have any suggestions/ideas please feel free to write about it. You are also welcome to fork this project and send pull request with your changes.
This project is licensed under the MIT License - see the LICENSE.md file for details