movie-rental-system

KO | EN

gitlite — search

#javascript #python #llm #golang #android #machine-learning #rust #linux #docker #nodejs #java #kubernetes #pytorch #mcp

movie-rental-system

(★ 25)

No description available.

movie-rental-system Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🎬 Movie Rental System

![Angular](https://img.shields.io/badge/Frontend-Angular-red)
![Node.js](https://img.shields.io/badge/Backend-Node.js-green)
![MongoDB](https://img.shields.io/badge/Database-MongoDB-brightgreen)
![License](https://img.shields.io/badge/Project-University-blue)

---

## 📌 Project Overview

The **Movie Rental System** is a web-based application that allows users to browse, search, and rent movies online.

The system provides a digital alternative to traditional movie rental stores by allowing users to manage their rentals through a simple and intuitive web interface.

The application uses **Angular** for the frontend and **Node.js with Express** for the backend API. Data is stored in **MongoDB** hosted on **MongoDB Atlas**.

> This repository demonstrates the full Software Engineering lifecycle, from system specification and design to Agile planning and testing.

---

## 👥 Users of the System

### Customer

- Register an account
- Login to the system
- Browse available movies
- Search for movies
- Rent movies
- View rental history

### Administrator

- Add new movies
- Update movie details
- Delete movies
- Manage movie availability

---

## ⚙️ Technology Stack

### Frontend

- Angular
- HTML
- CSS
- TypeScript

### Backend

- Node.js
- Express.js
- REST API

### Database

- MongoDB
- MongoDB Atlas

### Version Control

- Git
- GitHub

---

## 🏗 System Architecture

The system architecture consists of three main components.

### System Architecture Diagram

```mermaid
flowchart LR

Customer[Customer] --> Frontend[Angular Frontend]
Admin[Administrator] --> Frontend

Frontend --> API[Node.js + Express API]
API --> Database[(MongoDB Atlas)]
```

### Architecture Explanation

**Frontend (Angular)**
Provides the user interface where customers browse movies and administrators manage the catalog.

**Backend (Node.js + Express)**
Processes business logic, authentication, and handles API requests between the frontend and the database.

**Database (MongoDB Atlas)**
Stores application data including users, movies, and rental records.

---

## 🔄 System Workflow

1. User opens the web application
2. User registers or logs into the system
3. User browses the movie catalog
4. User searches or selects a movie
5. The system processes the rental request
6. Rental information is stored in the database
7. The system confirms the rental to the user

---

## 📂 Project Structure

movie-rental-system
    │
    ├── frontend (Angular Application)
    │   ├── components
    │   ├── services
    │   └── models
    │
    ├── backend (Node.js API)
    │   ├── controllers
    │   ├── routes
    │   └── models
    │
    ├── README.md
    ├── SPECIFICATION.md
    ├── ARCHITECTURE.md
    ├── STAKEHOLDER_ANALYSIS.md
    ├── SYSTEM_REQUIREMENTS.md
    ├── REFLECTION.md
    ├── USE_CASE_DIAGRAM.md
    ├── USE_CASE_SPECIFICATIONS.md
    ├── TEST_CASES.md
    ├── REFLECTION_ASSIGNMENT5.md
    ├── USER_STORIES.md
    ├── PRODUCT_BACKLOG.md
    ├── SPRINT_PLAN.md
    ├── REFLECTION_A6.md
    └── images/

---

## 📚 Project Documentation

This project contains documentation created for multiple assignments in the Software Engineering module.

---

### 📘 Assignment 3 Documentation

These documents describe the initial system design and architecture.

- 📄 [System Specification](SPECIFICATION.md)
- 🏗 [System Architecture](ARCHITECTURE.md)

---

### 📗 Assignment 4 Documentation

These documents focus on stakeholder analysis and system requirements.

- 👥 [Stakeholder Analysis](STAKEHOLDER_ANALYSIS.md)
- ⚙️ [System Requirements](SYSTEM_REQUIREMENTS.md)
- 📝 [Reflection](REFLECTION.md)

---

### 📙 Assignment 5 Documentation

These documents focus on use case modelling, use case specifications, and system testing.

- 🎭 [Use Case Diagram](USE_CASE_DIAGRAM.md)
- 📄 [Use Case Specifications](USE_CASE_SPECIFICATIONS.md)
- ✅ [Test Cases](TEST_CASES.md)
- 📝 [Reflection – Assignment 5](REFLECTION_ASSIGNMENT5.md)

---

### 📕 Assignment 6 Documentation

These documents demonstrate the application of Agile methodology, including user story creation, backlog prioritisation, sprint planning, and reflection.

- 🧾 [User Stories](USER_STORIES.md)
- 📊 [Product Backlog](PRODUCT_BACKLOG.md)
- 🚀 [Sprint Plan](SPRINT_PLAN.md)
- 📝 [Reflection – Assignment 6](REFLECTION_A6.md)

---

### 📗 Assignment 7 Documentation

These documents demonstrate the analysis of GitHub project templates, implementation of a customised Kanban board, and reflection on Agile workflow management.

* 📊 [Template Analysis](TEMPLATE_ANALYSIS.md)
* 📋 [Kanban Explanation](KANBAN_EXPLANATION.md)
* 📝 [Reflection – Assignment 7](REFLECTION_A7.md)

## 🧩 Kanban Board Implementation

A custom Kanban board was created using the **Team Planning template** in GitHub Projects to manage Agile workflows for the system.

The board was customised by adding additional columns such as **Testing** and **Blocked** to improve workflow visibility and track task progress more effectively.

All user stories from Assignment 6 were linked as GitHub Issues and organised across the board based on their current development status. Tasks were assigned to the developer using @mentions, and labels such as **feature** were used to categorise work items.

The Kanban board provides a clear visual representation of task progress, supports efficient workflow management, and aligns with Agile development practices.

---

### 📘 Assignment 8 Documentation

These documents model the dynamic behaviour of the system using object state transitions and activity workflows, while also showing traceability to earlier requirements and Agile planning.

* 🔄 [State Transition Diagrams](STATE_TRANSITION_DIAGRAMS.md)
* 📝 [State Transition Explanations](STATE_TRANSITION_EXPLANATIONS.md)
* ▶️ [Activity Diagrams](ACTIVITY_DIAGRAMS.md)
* 📄 [Activity Diagram Explanations](ACTIVITY_DIAGRAM_EXPLANATIONS.md)
* 🔗 [Integration and Traceability](INTEGRATION_TRACEABILITY.md)

------

### 📘 Assignment 9 Documentation

* 📊 Domain Model
* 🧱 Class Diagram
* 📝 Reflection – Assignment 9

------

### 📘 Assignment 10 Documentation

This section demonstrates the transformation of UML class diagrams into working code, including the implementation of creational design patterns and unit testing.

#### 🔧 Implementation

The system was implemented using **JavaScript (Node.js)** due to its simplicity, flexibility, and alignment with modern web development practices. The implementation closely follows the UML Class Diagram developed in Assignment 9, ensuring consistency between design and code.

#### 🧱 Creational Design Patterns

The following creational design patterns were implemented to demonstrate different object creation strategies:

- **Simple Factory** – Used to centralize object creation for different vehicle types (Car, Bike, Truck), simplifying instantiation logic.
- **Factory Method** – Used for payment processing to allow different payment types (Credit Card, PayPal) to be created through a common interface.
- **Abstract Factory** – Used to create families of related objects (Windows and Mac UI components) without specifying their concrete classes.
- **Builder** – Used to construct complex objects (Pizza) step-by-step, allowing flexible object configuration.
- **Prototype** – Used to clone existing objects (Circle) to improve efficiency and avoid repeated object creation.
- **Singleton** – Used to ensure a single instance of the database connection, preventing multiple connections and maintaining consistency.

#### 🧪 Testing

Unit tests were written using **Jest** to verify:
- Correct object creation for each pattern
- Proper initialization of attributes
- Edge case handling (invalid inputs, cloning behaviour, singleton enforcement)

Test coverage was generated to ensure that all patterns were properly validated.

#### 📂 Project Structure

- `/src` – Core class implementations based on UML design
- `/creational_patterns` – Implementations of all six creational design patterns
- `/tests` – Unit tests validating each pattern and its behaviour

---

### 📘 Assignment 11 Documentation

This section introduces a repository layer to manage persistence of domain objects.

#### 🗄 Repository Design
A generic repository interface was created to support CRUD operations, ensuring consistency across all entities.

#### ⚙️ In-Memory Implementation
An in-memory storage approach using JavaScript objects was implemented for simplicity and fast testing.

#### 🔄 Abstraction Mechanism
A Factory Pattern was used to allow switching between different storage implementations (e.g., in-memory, database).

#### 🔮 Future-Proofing
A stub for a database repository was included to demonstrate how the system can be extended to support persistent storage.

#### 📂 Structure
- `/repositories` – Interfaces and implementations
- `/repositories/inmemory` – In-memory storage
- `/factories` – Repository factory
- `/tests` – Repository tests

---

### 📘 Assignment 12 Documentation

This section demonstrates the implementation of a service layer and REST API architecture for the Aura Reels Movie Rental System.

#### ⚙️ Service Layer

Service classes were implemented to encapsulate business logic and interact with the repository layer. The following services were created:

- MovieService
- UserService
- RentalService

The service layer validates inputs, enforces business rules, and separates application logic from persistence logic.

#### 🌐 REST API

RESTful API endpoints were implemented using Express.js to expose system functionality.

Implemented endpoints include:

- GET /api/movies
- POST /api/movies
- GET /api/users
- POST /api/users
- GET /api/rentals
- POST /api/rentals
- POST /api/rentals/{id}/complete

📄 [SCREENSHOTS](ASSIGNMENT12_SCREENSHOTS.md)

#### 📄 Swagger/OpenAPI Documentation

Swagger UI was integrated to provide interactive API documentation and endpoint testing.

Swagger URL:

http://localhost:3000/docs

---

### 📘 Assignment 13 Documentation

This section demonstrates the implementation of Continuous Integration and Continuous Deployment (CI/CD) practices using GitHub Actions.

#### 🔒 Branch Protection

Branch protection rules were configured to improve code quality and repository security.

The following rules were applied to the `main` branch:

- Require pull request reviews before merging
- Require status checks to pass before merging
- Restrict direct pushes to the main branch

📄 [Branch Protection Documentation](PROTECTION.md)

#### ⚙️ Continuous Integration (CI)

A GitHub Actions workflow was created to automatically run tests whenever code is pushed to the repository or a pull request is opened.

The CI pipeline performs:

- Repository checkout
- Node.js environment setup
- Dependency installation
- Automated test execution using Jest

#### 🚀 Continuous Deployment (CD)

The workflow was extended to generate a release artifact when changes are merged into the main branch.

The CD pipeline performs:

- Build validation after successful tests
- Artifact generation
- Artifact upload to GitHub Actions

#### 🧪 Automated Testing

All unit and integration tests are executed automatically through GitHub Actions to ensure code quality before deployment.

#### 📂 Project Structure

- `/.github/workflows` – GitHub Actions workflow configuration
- `PROTECTION.md` – Branch protection justification
- `/tests` – Automated test suites

---

### 📘 Assignment 14 Documentation

This section prepares the Aura Reels Movie Rental System for open-source collaboration and contributor onboarding.

#### 🤝 Contributing

The repository now includes contribution guidelines to help new contributors understand the development workflow.

📄 [Contributing Guidelines](CONTRIBUTING.md)

#### 🗺 Project Roadmap

Future development plans and enhancement opportunities are documented in the roadmap.

📄 [Project Roadmap](ROADMAP.md)

#### 📄 License

This project uses the MIT License.

📄 [MIT License](LICENSE)

#### 🚀 Getting Started

##### Prerequisites

* Node.js
* Git
* Visual Studio Code (recommended)

##### Installation

```bash
git clone https://github.com/ThaakirahA/movie-rental-system.git
cd movie-rental-system
npm install
```

##### Run Tests

```bash
npm test
```

##### Start Development

```bash
npm start
```

#### 🌟 Features for Contribution

| Feature                            | Difficulty   | Label            |
| ---------------------------------- | ------------ | ---------------- |
| Improve README formatting          | Beginner     | good-first-issue |
| Swagger documentation improvements | Beginner     | good-first-issue |
| Movie rating validation            | Beginner     | good-first-issue |
| Watchlist functionality            | Intermediate | feature-request  |
| Movie review system                | Intermediate | feature-request  |
| Email rental notifications         | Advanced     | feature-request  |

#### 👥 Open-Source Collaboration

The repository has been prepared for external contributors through:

* Contribution guidelines
* Issue labeling
* Project roadmap
* CI/CD automation
* Branch protection rules
* Pull request workflow

---

## 🚀 Future Improvements

Possible future features include:

- Movie ratings and reviews
- Online payment integration
- Movie recommendation system
- Watch movie trailers
- Mobile application support

---

## 👨‍💻 Author

ThaakirahA

Software Development

Honours Student – Software Engineering

GitHub: https://github.com/ThaakirahA

movie-rental-system

movie-rental-system Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

movie-rental-system

movie-rental-system Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README