A modern web application which identifies faces in images and display its boundaries.
Explore the docs »
View Demo
·
Report Bug / Request Feature
Table of Contents
MagicBrain is a modern web application on which users can sign up for a new user, login with their existing user, submit their favorite friends and family photos and have theirs faces identified.
This project was originally built as part of a Full Stack pratical exercise to expand on React knowledge (including login, hooks and routes) and Rest API building and integration. Later on, tests with Jest and React Testing Library were also added to the project.
MagicBrain was built with the following technologies:
To get a local copy up and running follow these simple example steps.
Have npm installed in your machine.
- npm
npm install npm@latest -g
On terminal
- Clone the repo
git clone https://github.com/sgtbrunner/magicbrain
- Navigate to project folder
cd magicbrain - Install NPM packages
npm install
Run the following commands on terminal within the project folder
-
Starting the app
npm start
If you browser doesn't open automatically, open it and navigate to
http://localhost:3000/
To fully benefit from MagicBrain login and face detection capabilities, it is required to either run the MagicBrain API (default PORT 5000) or point the development environment
REACT_APP_API_ENDPOINTconfig constant in the.env.developmentfile tohttps://mighty-beyond-04256.herokuapp.com.
Once loaded, you can sign up or login onto the app...
...submit your favorite family/friend picture and see all the magic happening! -
Formatting the app
npm run format
-
Linting the app
npm run lint
-
Testing the app
npm testTo check for testing coverage:
npm run test-coverage
-
Building the app
npm run build
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Guilherme Brunner - guilherme.brunner@gmail.com
Project Link: https://github.com/sgtbrunner/magicbrain