keylan1 / myflix-angular-client

Angular mFlix App

This project is a single-page, responsive movie app built with Angular, featuring routing and multiple interface views. It serves as the client-side component for the existing server-side from Achievement 2, facilitating user requests and rendering server responses through various interface views. The app includes documentation and handoff deliverables, such as a kanban board with user stories and story points.

5 W’s

• Who: The users of the MyFlix movie app and codebase, including developers and designers.
• What: A single-page, responsive movie app built with Angular that supports user authentication, displays movie information, and allows users to manage their favorite movies.
• When: Users can access the app at any time to learn more about movies or update their user information.
• Where: The app is hosted online, offering equal access on any device.
• Why: The app provides movie enthusiasts with information about movies, directors, and genres. It also showcases Angular skills and documentation abilities.

Design Criteria

User Stories

• As a user, I want to access information on movies, directors, and genres.
• As a user, I want to create a profile to save my favorite movies.

Key Features

• Welcome View: Allows users to log in or register an account.
• All Movies View: Displays a list of all movies.
• Movie View: Shows detailed movie information and offers access to director and genre details.
• Director View: Displays information about the director of a selected movie.
• Genre View: Presents information about a selected movie genre.
• Synopsis View: Presents a brief description of the movie.

Technical Requirements

• Angular (version 9 or later)
• Node.js and npm
• User registration and login forms
• Angular Material for design
• Code comments using Typedoc
• Technical documentation using JSDoc
• Hosting on GitHub Pages

Development

Development server

This project was generated with Angular CLI version 16.2.1.

To run the development server, use the following commands:

git clone <repository-url>
cd MyFlixAngularClient
npm install
ng serve

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.