NodeJS-ExpressJS

Hotel API

A backend API for managing hotels, rooms, and their images, allowing to create, update, and retrieve hotel and room information with images.

Features
Installation
Database Setup
File Structure
Hotel Data Schema
Setup and Configuration
Running the Application
API Endpoints
Testing

Technical Requirements

Node.js and Express.js: The API is built using Node.js for the runtime environment and Express.js as the web framework.
TypeScript: TypeScript is used for better code quality, enhanced developer experience, and type safety in the codebase.
Data Storage: Data is stored in JSON files (instead of a database) under the data folder. Each hotel and room's information is saved as individual JSON files.
File Uploads: Multer is used to handle image uploads for hotels and rooms. Images are saved in the uploads directory.
Data Validation & Error Handling:
- All incoming data is validated to ensure it meets the necessary criteria.
- Errors are handled properly with appropriate error messages returned to the client.
HTTP Status Codes:
- 200 OK for successful operations (e.g., data retrieval, updates).
- 404 Not Found for resources that cannot be found.
- 500 Internal Server Error for unexpected issues or server failures.

Features

Hotel Management: Create, update, and fetch hotels by ID or slug.
Room Management: Upload images for rooms along with hotel creation.
Image Uploads: Support for multiple images per hotel and room using multer.

Installation

Step 1: Clone the Repository

git clone [https://github.com/siddiqua14/NodeJS-ExpressJS.git]
cd hotel-api

Step 2: Install Required Packages

Install all necessary packages listed in package.json by running:

npm install

Packages Installed

express - Fast and lightweight web framework for Node.js - npm install express
multer - Middleware for handling file uploads -npm install multer
path, fs - Node.js native modules for file and path operations
slugify - For generating URL-friendly slugs from titles - npm install slugify
jest, supertest - For testing API endpoints - npm install jest --save-dev , npm install supertest --save-dev

Database Setup

For this setup, storing data in JSON files under a data folder.

Step 1: Create a Data Folder

In the project root, create a data folder: mkdir data This folder will store each hotel’s JSON file.

File Structure

project structure: hotel-api/
│
├── src/
│ ├── controllers/
│ │ └── hotel.controller.ts # Main controller for handling API logic
│ ├── middleware/
│ │ └── hotel.middleware.ts # Middleware setup for file uploads (Multer)
│ │ └── validationErrorHandler.ts # Error handling middleware
│ ├── routes/
│ │ └── hotel.routes.ts # API routes configuration
│ ├── models/
│ │ └── hotel.types.ts # TypeScript types for data
│ ├── data/ # Folder for JSON data files
| ├── uploads/ # Folder for storing uploaded images
| | └── rooms/ # Folder for storing uploaded images-->Rooms
| ├── validations/ # Input validation rules and schemas
| | └── hotel.validation.ts
| ├── app.ts # Main application file
| └── server.ts # Server configuration and startup
|
├── test/ # Folder containing test files
│ └── hotel.test.ts # Tests for API endpoints
├── hotel-api.postman_collection.json # Postman collection for API testing
├── jest.config.js # Jest testing configuration
├── package-lock.json
├── package.json # Project dependencies and scripts
├── README.md
└── tsconfig.json # TypeScript configuration

Hotel Data Schema

The hotel data is structured in a JSON format with the following fields:

Hotel Object

ID: Unique identifier for the hotel.
Slug: A URL-friendly version of the hotel title (e.g., "grand-hotel").
Title: Name of the hotel.
Description: A brief description of the hotel.
Guest Count: The maximum number of guests the hotel can accommodate.
Bedroom Count: The number of bedrooms available in the hotel.
Bathroom Count: The number of bathrooms available in the hotel.
Amenities: A list of amenities offered by the hotel (e.g., WiFi, Air Conditioning).
Host Information: Details about the host (e.g., name, contact).
Address: The physical address of the hotel.
Latitude: The geographical latitude of the hotel.
Longitude: The geographical longitude of the hotel.
Images: Array of images representing the hotel (e.g., exterior, interior images).

Room Object (Multiple Rooms Per Hotel)

Hotel Slug: The slug for the hotel (used for linking rooms to their respective hotels).
Room Slug: A URL-friendly version of the room title (e.g., "room-1").
Room Image: An array of images representing the room.
Room Title: The title of the room (e.g., "Ocean View Room").
Bedroom Count: The number of bedrooms in the room.

Setup and Configuration

To add TypeScript to the project(if not), follow these steps:

Step 1: Install TypeScript and TypeScript Definitions

Compile the code by running:

npm install typescript --save-dev
npm install @types/node --save-dev

Step 2: Initialize a `tsconfig.json` File

npx tsc --init
In my project updated tsconfig.json with the following configuration:

{
    "compilerOptions": {
        "target": "es6",                   // Set the JavaScript language version.
        "module": "commonjs",              // Module system for Node.js compatibility.
        "moduleResolution": "node",        // Use Node.js resolution strategy.
        "rootDir": "./src",                // Location of your source files.
        "outDir": "./dist",                // Location for compiled files.
        "esModuleInterop": true,           // Enables compatibility with ES modules and CommonJS.
        "strict": true,                    // Enable strict type checking.
        "skipLibCheck": true,
        "resolveJsonModule": true          // Allow importing JSON files.
    },
    "include": ["src/**/*.ts"],          // Ensure only .ts files in src are compiled.
    "exclude": ["node_modules", "dist"]  // Exclude unnecessary folders.
}

Step 3: Modify `package.json`

"scripts": {
  "start": "node dist/app.js",        // Start the compiled JavaScript file.
  "dev": "nodemon --exec ts-node src/app.ts", // For running in development with automatic reloading.
  "build": "tsc",                     // Compile TypeScript files.
  "test": "jest",                     // Run tests using Jest.
  "test:watch": "jest --watch"        // Run tests with watch mode.
}

Step 4: Install Development Dependencies

npm install ts-node nodemon --save-dev

Running the Application

Step 1: Compile TypeScript

Compile the code by running:

npx tsc

Step 2: Start the Server

Start the server using:

npm run dev The API should now be running on http://localhost:5050.

API Endpoints

1. Create a New Hotel

Method: POST
URL: http://localhost:5050/api/hotel

Body:

{
"title": "Season Hotel",
"description": "A Luxury place to stay",
"guestCount": 5,
"bedroomCount": 2,
"bathroomCount": 2,
"amenities": ["WiFi", "Air Conditioning"],
"host": "John Doe",
"address": "123 Street, City, Country",
"latitude": 40.7128,
"longitude": -74.0060,
"rooms": [
    {
    "roomSlug": "room1",
    "roomTitle": "Room 1",
    "bedroomCount": 1
    }
]
}

Response: 201 Created

2. Get Hotel by ID or Slug

Method: GET
URL: http://localhost:5050/api/hotel/:idOrSlug
Response: 200 OK or 404 Not Found

3. Update Hotel by ID

Method: PUT
Endpoint: /hotel/:id
Body:
```
{ "title": "Updated Hotel Name" }
```
Response: 200 OK or 404 Not Found

4. Upload Hotel Images

Method: POST
URL: http://localhost:5050/api/images/:id
Form-Data:
- images: Upload images in form-data with key images.
Response: 200 OK or 404 Not Found

5. Upload Room Images

Method: POST
URL: http://localhost:5050/api/room/images/:id/:roomSlug
Form-Data:
- images: Upload images in form-data with key images.
Response: 200 OK or 404 Not Found

Testing

Jest and Supertest have been set up to test the API endpoints.

Ensure that you have the necessary test setup:

Jest is set up for running tests.
Supertest is used for making requests to the API during tests.
Test files are located in the _test_/ directory. For example, the file hotel.test.ts contains tests for the hotel API.

Run Tests

To run the tests: npm test

siddiqua14/NodeJS-ExpressJS