myFlix App

myFlix App

An app that allow its users to search, find, and store data around movies and relating topics.
Explore the docs »

View Project · Report Bug · Request Feature

Table of Contents (click to expand)

1. About The Project
2. Built With
3. Key Features
4. Getting Started
5. Usage
6. How to run this project
7. Roadmap
8. Contributing
9. License
10. Contact
11. Acknowledgments

About The Project

The objective for this project is, using React to build the client-side for the myFlix database based on its existing server-side code (REST API and database).

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Key Features

The following shows a list of views, which are considered essential feature requirements for this project.

• Main view

  • Returns a list of ALL movies to the user (each listed item with an image, title, and description)
  • Sorting and filtering
  • Ability to select a movie for more details

• Single movie view

  • Returns data (description, genre, director, image) about a single movie to the user
  • Allows users to add a movie to their list of favourites

• Login view

  • Allows users to log in with a username and password
  • Registration view
  • Allows new users to register (username, password, email, birthday)

• Genre view

  • Returns data about a genre, with a name and description
  • Displays example movies

• Director view

  • Returns data about a director (name, bio, birth year, death year)
  • Displays example movies

• Profile view

  • Allows users to update their user info (username, password, email, date of birth)
  • Allows existing users to deregister
  • Displays favourite movies
  • Allows users to remove a movie from their list of favourites

(back to top)

Technical requirements

• The application must be a single-page application (SPA)
• The application must use state routing to navigate between vies and share URLs
• The application must give users the option to filter movies
• The application must give users the option to sort movies
• The application must initially use Parcel as its build tool
• The application must be written using the React library and in ES2015+
• The application must be written with React Redux (hence respecting Flux pattern)
• The application must use Bootstrap as a UI library for styling and responsiveness
• The application must contain a mix of class components and function components
• The application may be hosted online

(back to top)

How to run this project

1. Install parcel locally npm install parcel

2. Clone the repository

git clone https://github.com/patricklemmer/myFlix-client.git

3. Install all dependencies npm install

4. Run the app on localhost:1234 parcel src/index.html

(back to top)

Version Roadmap (to be updated)

The following will be released in v.1.1.0:

[ ] Real time form validation for registration view

[ ] Actor view displaying actor related information

[ ] Additional information displayed within:

• Movie view:
  • List of actors per movie
• Director view:
  • to be evaluated

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this app better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

None

(back to top)

Contact

(back to top)

Acknowledgments (to be updated)

(back to top)