Skip to content

codestun/FlickPick-Angular-client

Repository files navigation

FlickPick Angular Client

Overview

Welcome to FlickPick, a single-page, responsive movie app built with Angular. This client-side interface complements the existing server-side code, the REST API and database. FlickPick offers users access to a wide array of information about movies, directors, and genres, and allows for personalized profile management.

Features

  • User Authentication: Secure registration and login to access personalized features.
  • Movie Information: Detailed insights into movies, directors, and genres.
  • Profile Management: Create and manage profiles, including saving favorite movies.

Tech Stack

  • Frontend: Angular (version 9 or later) with Typescript
  • Backend: REST API
  • Database: MongoDB
  • User Interface: Angular Material
  • Documentation: Typedoc, JSDoc
  • Hosting: GitHub Pages

Live Demo

Experience FlickPick Angular Client live here.

Getting Started

Prerequisites

Ensure you have the latest version of Node.js and npm installed.

Installation

  1. Clone the repository: git clone https://github.com/your-username/FlickPick-angular.git
  2. Navigate to the project directory: cd FlickPick-angular
  3. Install dependencies: npm install

Usage

  • Development Server: Run ng serve and navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
  • Code Scaffolding: Run ng generate component component-name or use other ng generate commands.
  • Build: Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Testing

  • Unit Tests: Run ng test via Karma.
  • End-to-End Tests: Run ng e2e after adding a package that implements e2e testing capabilities.

Documentation

  • Codebase Comments: Documented using Typedoc.
  • Project Documentation: Available in the docs/ directory and via JSDoc.

User Flow Diagrams

For detailed user flow diagrams, see the PDFs below:

Further Help

For more information on Angular CLI commands, refer to the Angular CLI Overview and Command Reference.