Scheduly: Appointments scheduler

Scheduly is a appointment scheduling application, designed to streamline the process of booking appointments. Similar to Calendly, Scheduly provides a user-friendly interface where individuals can view available time slots and book appointments with ease.

Installation

This application can be installed in two ways:

Using Docker (Production Only | Recommended)
Manual Installation

For both the cases the application runs on port 3000

1. Installation using Docker

Please note: This method can only be used for production. For development, kindly follow manual Installation

Once the application is cloned, run cp .env.example .env to create a .env file by copying the .env.example file given. For the ease of setup, the .env file comes prefilled with data, however add your own credentials if required.
If Docker Process is running, run docker compose up -d (for legacy version run docker-compose up -d) which will initiate the build processes.
Once the containers are built and running, enter into interactive shell of web container using the following command: docker exec -it scheduly_app /bin/sh. Put proper container name, however in our case it is supposed to be scheduly_app.
Once inside the shell run sh ./scripts/migrate.sh to generate schemas and migrate the schema to the database

Manual Installation

Note: Before starting manual installation keep your PostgreSQL database service ready as it is required during setup

1. Once the application is cloned, run cp .env.example .env to create a .env file by copying the .env.example file given. For the ease of setup, the .env file comes prefilled with data, however add your own credentials if required.
Run npm install to install dependencies
Run npm run migrate to generate schemas and migrate to database.
Run npm run dev to start development

To build the application for production:

Run npm run build for building the application
Use npm start to start the server and listen.

Application Architecture

This application employs a standard 3-tier web application architecture, encompassing a client, server, and database. This structure is designed to facilitate scalability in the future, if necessary. Moreover, the application is containerized, enhancing its portability and ease of deployment.

This application was written using NextJS and uses NextJS Actions to communicate with server, and uses PostgreSQL for storing data. Commications with database is done using DrizzleORM.

Adminer is used to monitor database.

Project Structure

Project structure is as follows:

public: for hosting static files
scripts: for various scripts that can be run inside container
src: source files
- app: main application files
  - [page]: files for a given page
    - components: page level components
    - _actions.tsx: file to handle actions used by the given page (_ is prepended to imply its not a component)
    - loading.tsx: component for handling loading state
    - page.tsx: main component for the given page
  - globals.css: Global CSS file
  - layout.tsx: Main layout of the application
  - page.tsx: component for rendering homepage, but acts as an entrypoint in this case.
  - favicon: Favicon for the application
- components: For top-level components
- database: for managing database
  - index.tsx: initialises and exports database object
  - migrate.tsx: migrates generated schema using DrizzleORM
  - schema.tsx: schemas for DrizzleORM for various entities used in the application
- utils: for storing files for misc and utitilites
  - declarations: for various declarations used in the application

Assumptions made during development

For the development of this application I've made the following assumptions:

Each appointment lasts for about 30 minutes only
User refreshes the page after booking an appointment
SSL/TLS is not used to connect to PostgreSQL
User is available on all the days initially chosen during creating the schedule

Possible enhancements

If given more time, the following features could be implemented:

An authentication system
See bookings made across different schedules by a user (currently bookings for one particular schedule can be seen)
Edit and delete schedules
Postpone bookings
Better Error handling and validation of data

neilkerman/scheduly