Booking System TypeScript API

This is a RESTful API built using NestJS and TypeScript that enables users to reserve appointments through a booking system. The API provides functionality for managing availability, user authentication, and notifications for booking confirmations or reminders.

Features

Availability Management: The API allows administrators to manage the availability of appointments, services, or resources. This includes defining working hours.
User Authentication: Users can sign up, log in, and manage their bookings through authenticated routes. Authentication ensures that only authorized users can access protected endpoints.
Booking Reservations: Users can reserve appointments, services, or resources by specifying the desired date, time slot, and any additional details. The API handles the validation of available slots and creates bookings accordingly.
Notifications: Users receive notifications for booking confirmations and reminders. This feature helps users stay informed about their upcoming reservations and reduces the risk of missed appointments.

Installation

Clone the repository: git clone https://github.com/BaseMax/BookingGraphQLTS.git
Navigate to the project directory: cd BookingGraphQLTS
Install the dependencies: yarn install

Configuration

Open the .env file and modify the configuration variables according to your needs. This may include database connection settings, authentication secrets, and email notification settings.

Database Setup

Create a database for the application.
Update the DATABASE_URL variable in the .env file with your database connection string.

Firebase Setup

-create a firebase project in fire store and import configuration into firebase-adminsdk in root of the project in json format

Running the Application

To start the API server, run the following command:

npm run start

The server will start running on http://localhost:3000 by default. You can modify the port in the .env file.

API Documentation

The API documentation can be found at http://localhost:3000/api/swagger when the server is running. It provides detailed information about the available endpoints, request/response formats, and authentication requirements.

Testing

To run the tests for the API, use the following command:

npm run test

The test suite includes unit tests, integration tests, and end-to-end tests to ensure the functionality of the API.

API Routes

Route	Method	Description
`/api/auth/signup`	POST	Register a new user account
`/api/auth/login`	POST	Authenticate and log in a user
`/api/auth/logout`	POST	Log out the currently authenticated user
`/api/bookings`	GET	Get all bookings (admin only)
`/api/bookings`	POST	Create a new booking
`/api/bookings/:id`	GET
`/api/bookings/:id`	PUT	Update a specific booking by ID
`/api/bookings/:id`	DELETE	Delete a specific booking by ID
`/api/availability`	GET	Get availability for a specific date
`/api/availability`	POST	Add availability for a specific date
`/api/availability/:id`	GET	Get availability by ID
`/api/availability/:id`	PUT	Update availability by ID
`/api/availability/:id`	DELETE	Delete availability by ID
`/api/users`	GET	Get all users (admin only)
`/api/users/:id`	GET	Get a specific user by ID
`/api/users/:id`	PUT	Update a specific user by ID
`/api/users/:id`	DELETE	Delete a specific user by ID
`/api/resource`	POST	Creating a new resource for any organization or services
`/api/resource`	GET	Getting all resources available on the system
`/api/resource/:id`	PUT	Modifying the resource
`/api/resource/:id`	DELETE	Delete a specific resource by ID
`/api/notification/:id`	POST	sending a notification to a specific user by id and title and body provided
This table provides an overview of the routes available in the Booking System API, along with their associated HTTP methods and descriptions. Please note that this is just a sample and you may have additional routes or modify the existing ones based on your specific project requirements.

Models

User Model

interface User {
  id: number;
  name: string;
  email: string;
  password: string;
  isAdmin: boolean;
  bookings : Booking[];
  notifications : Notifications[];
  createdAt: Date;
  updatedAt: Date;
}

Booking Model

interface Booking {
  id: number;
  userId: number;
  resourceId: number;
  startDate: Date;
  endDate: Date;
  notes: string;
  createdAt: Date;
  updatedAt: Date;
}

Resource Model

interface Resource {
  id: number;
  name: string;
  description: string;
  booking: Booking[];
  Availability Availability[];
  createdAt: Date;
  updatedAt: Date;
}

Availability Model

interface Availability {
  id: number;
  resourceId: number;
  date: Date;
  slots: AvailabilitySlot[];
  createdAt: Date;
  updatedAt: Date;
}

interface AvailabilitySlot {
  startTime: Date;
  endTime: Date;
  availabilityId : number;
}

interface Notificaiton {
  id : number;
  device_type:  string;
  notification_token : string;
  userId : number;
  title : string;
  body : string;
}

These models represent the entities used in the Booking System API. The User model represents a user account, the Booking model represents a booking made by a user, the Resource model represents a resource that can be booked, and the Availability model represents the availability of a resource on a specific date, divided into slots.

API JSON Examples

Sign Up Request Example

{
  "name": "John Doe",
  "email": "johndoe@example.com",
  "password": "secretpassword"
}

Sign Up Response Example

{
  "user": {
    "id": 1,
    "name": "John Doe",
    "email": "johndoe@example.com",
    "isAdmin": false,
    "createdAt": "2023-06-08T12:00:00Z",
    "updatedAt": "2023-06-08T12:00:00Z"
  },
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Log In Request Example

{
  "email": "johndoe@example.com",
  "password": "secretpassword"
}

Log In Response Example

{
  "user": {
    "id": 1,
    "name": "John Doe",
    "email": "johndoe@example.com",
    "isAdmin": false,
    "createdAt": "2023-06-08T12:00:00Z",
    "updatedAt": "2023-06-08T12:00:00Z"
  },
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Create Booking Request Example

{
  "resourceId": 1,
  "startDate": "2023-06-10T09:00:00Z",
  "endDate": "2023-06-10T10:00:00Z",
  "notes": "Need a consultation"
}

Create Booking Response Example

{
  "booking": {
    "id": 1,
    "userId": 1,
    "resourceId": 1,
    "startDate": "2023-06-10T09:00:00Z",
    "endDate": "2023-06-10T10:00:00Z",
    "notes": "Need a consultation",
    "createdAt": "2023-06-08T12:00:00Z",
    "updatedAt": "2023-06-08T12:00:00Z"
  }
}

Please note that these examples demonstrate the structure of JSON objects, and the actual values will depend on the data you provide in your requests and receive in your responses.

API Structure Examples

Here's an example of the request and response bodies for the routes in the Booking System API:

Sign Up (POST /api/auth/signup)

Request Body

interface SignUpRequest {
  name: string;
  email: string;
  password: string;
}

Response Body

interface SignUpResponse {
  user: User;
  token: string;
}

Log In (POST /api/auth/login)

Request Body

interface LoginRequest {
  email: string;
  password: string;
}

Response Body

interface LoginResponse {
  user: User;
  token: string;
}

Log Out (POST /api/auth/logout)

No Request Body

No Response Body

Get All Bookings (GET /api/bookings)

No Request Body

Response Body

interface GetAllBookingsResponse {
  bookings: Booking[];
}

Create Booking (POST /api/bookings)

Request Body

interface CreateBookingRequest {
  resourceId: number;
  startDate: Date;
  endDate: Date;
  notes: string;
}

Response Body

interface CreateBookingResponse {
  booking: Booking;
}

Get Booking by ID (GET /api/bookings/:id)

No Request Body

Response Body

interface GetBookingResponse {
  booking: Booking;
}

Update Booking by ID (PUT /api/bookings/:id)

Request Body

interface UpdateBookingRequest {
  startDate?: Date;
  endDate?: Date;
  notes?: string;
}

Response Body

interface UpdateBookingResponse {
  booking: Booking;
}

Delete Booking by ID (DELETE /api/bookings/:id)

No Request Body

No Response Body

Get Availability for Date (GET /api/availability)

Request Body

interface GetAvailabilityRequest {
  date: Date;
}

Response Body

interface GetAvailabilityResponse {
  availability: Availability[];
}

Add Availability for Date (POST /api/availability)

Request Body

interface AddAvailabilityRequest {
  resourceId: number;
  date: Date;
  slots: AvailabilitySlot[];
}

Response Body

interface AddAvailabilityResponse {
  availability: Availability;
}

Get Availability by ID (GET /api/availability/:id)

No Request Body

Response Body

interface GetAvailabilityResponse {
  availability: Availability;
}

Update Availability by ID (PUT /api/availability/:id)

Request Body

interface UpdateAvailabilityRequest {
  slots?: AvailabilitySlot[];
}

Response Body

interface UpdateAvailabilityResponse {
  availability: Availability;
}

Delete Availability by ID (DELETE /api/availability/:id)

No Request Body

No Response Body

Get All Users (GET /api/users)

No Request Body

Response Body

interface GetAllUsersResponse {
  users: User[];
}

Get User by ID (GET /api/users/:id)

No Request Body

Response Body

interface GetUserResponse {
  user: User;
}

Update User by ID (PUT /api/users/:id)

Request Body

interface UpdateUserRequest {
  name?: string;
  email?: string;
  password?: string;
}

Response Body

interface UpdateUserResponse {
  user: User;
}

Delete User by ID (DELETE /api/users/:id)

No Request Body

No Response Body

Please note that these are just examples, and the actual request and response bodies may vary based on your specific project requirements. You can customize the request and response bodies by adding or removing fields as needed.

Contributing

Contributions are welcome! If you find any bugs or want to suggest new features, please open an issue or submit a pull request to the repository.

License

This project is licensed under the GPL-3.0 License.

BaseMax/BookingAPITS

Booking System TypeScript API

Features

Installation

Configuration

Database Setup

Firebase Setup

Running the Application

API Documentation

Testing

API Routes

Models

User Model

Booking Model

Resource Model

Availability Model

API JSON Examples

Sign Up Request Example

Sign Up Response Example

Log In Request Example

Log In Response Example

Create Booking Request Example

Create Booking Response Example

API Structure Examples

Sign Up (POST /api/auth/signup)

Log In (POST /api/auth/login)

Log Out (POST /api/auth/logout)

Get All Bookings (GET /api/bookings)

Create Booking (POST /api/bookings)

Get Booking by ID (GET /api/bookings/:id)

Update Booking by ID (PUT /api/bookings/:id)

Delete Booking by ID (DELETE /api/bookings/:id)

Get Availability for Date (GET /api/availability)

Add Availability for Date (POST /api/availability)

Get Availability by ID (GET /api/availability/:id)

Update Availability by ID (PUT /api/availability/:id)

Delete Availability by ID (DELETE /api/availability/:id)

Get All Users (GET /api/users)

Get User by ID (GET /api/users/:id)

Update User by ID (PUT /api/users/:id)

Delete User by ID (DELETE /api/users/:id)

Contributing

License