Skip to content

dmcdaniel90/smartbrain

Repository files navigation

Facial Recognition App

This is a React-based application that uses machine learning to recognize faces in images.

Learning Journey

This project has been a great opportunity to learn and understand the practical implementation of React and Machine Learning. I've learned how to create a React application from scratch, convert a class-component app to use functional components, manage state with hooks and with state management tooling (Zustand), and integrate with an external Machine Learning API for facial recognition. I've also learned how to write tests for React components and manage dependencies.

Installation

  1. Clone the repository
  2. Navigate to the facialrecognitionapp directory
  3. Install the dependencies with npm install

Usage

To start the application, use the command npm start from the facialrecognitionapp directory. This will start the application in your default web browser. You can then use the application to upload images and see the facial recognition in action.

Testing

To run the tests for the application, use the command npm test from the facialrecognitionapp directory.

Dependencies

This project uses the following dependencies:

  • react: ^17.0.2
  • react-dom: ^17.0.2
  • react-scripts: 4.0.3
  • react-tilt: ^0.1.4
  • tachyons: ^4.12.0
  • particles.js: ^2.0.0
  • react-particles-js: ^3.4.1
  • @testing-library/jest-dom: ^5.11.4
  • @testing-library/react: ^11.1.0
  • @testing-library/user-event: ^12.1.10
  • immer: ^10.0.3
  • zustand: ^4.5.0

API Repository

The API for this application is hosted in a separate repository. You can find it here.

Screenshots

Login Page Recognition Screen

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT