https://github.com/codestun/flickpick-angular-client

Welcome to FlickPick, a single-page, responsive movie app built with Angular.
https://github.com/codestun/flickpick-angular-client

angular angular-client angular-material jsdoc mongodb rest-api rest-api-client typedoc typescript

Last synced: 19 days ago
JSON representation

Welcome to FlickPick, a single-page, responsive movie app built with Angular.

• Host: GitHub
• URL: https://github.com/codestun/flickpick-angular-client
• Owner: codestun
• Created: 2024-01-05T15:51:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-27T13:09:08.000Z (12 months ago)
• Last Synced: 2024-11-09T23:14:54.447Z (3 months ago)
• Topics: angular, angular-client, angular-material, jsdoc, mongodb, rest-api, rest-api-client, typedoc, typescript
• Language: TypeScript
• Homepage: https://codestun.github.io/FlickPick-Angular-client/
• Size: 955 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://github.com/codestun/FlickPick-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](https://codestun.github.io/FlickPick-Angular-client/welcome).

## Getting Started

### Prerequisites

Ensure you have the latest version of [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) 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](https://karma-runner.github.io).

- **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:

- [User Flow Diagram 1](./pdfs/user_flow1.pdf)

- [User Flow Diagram 2](./pdfs/user_flow2.pdf)

- [User Flow Diagram 3](./pdfs/user_flow3.pdf)

## Further Help

For more information on Angular CLI commands, refer to the [Angular CLI Overview and Command Reference](https://angular.io/cli).