Skip to content

Hokkyokukou/smartbrain

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SmartBrain - Face Detection App 👁️✨

Personal Description:
SmartBrain is a milestone project that brings together all the skills I acquired in my full-stack development journey. Through this app, I aimed to create a practical and interactive face detection solution, combining React for the front-end, Node.js and Express.js for the back-end (see SmartBrain API), and PostgreSQL as the database. This project showcases a hands-on approach to programming with machine learning applications and serves as a potential foundation for implementing future features in AI and computer vision.


Key Features 🌟

  • Face Detection: Using the Clarifai API, SmartBrain detects faces in uploaded images, providing an interactive and engaging user experience.
  • React Front-End: The front-end is built with React, creating a responsive and dynamic interface focused on simplicity and usability.
  • Node.js and Express Back-End: This app uses a Node.js and Express server architecture to handle API logic efficiently (see SmartBrain API).
  • PostgreSQL Database: User data and interactions are stored in a PostgreSQL database, ensuring data integrity and persistence.

Project Objectives 🏆

SmartBrain is designed as a showcase of practical full-stack skills. Specifically, this app demonstrates:

  • Basic knowledge of machine learning and external API integration for visual detection.
  • The ability to build a complete system, from front-end to back-end and database.
  • Experience in deploying applications on cloud platforms.

Setup & Run 💻

Follow these steps to set up and run both the front-end and back-end of the SmartBrain application:

  1. Clone the repository:

    git clone https://github.com/Hokkyokukou/smart-brain.git
    cd smart-brain
  2. Install dependencies:

    npm install
  3. Set up environment variables: Create a .env file in the root folder with the following variables:

    REACT_APP_API_URL=your_server
    
  4. Clone the server repository: To run the back-end server, you will need to clone a separate repository:

    git clone https://github.com/Hokkyokukou/smart-brain-api.git
    node server.js
    cd smart-brain-api
    npm install
  5. Set up environment variables for the server: Create a .env file in the server folder with the following variables:

    CLARIFAI_API_KEY=your_key
    APP_ID=face-recognition-brain
    DATABASE_DB=your_database_db
    DATABASE_HOST=your_database_host
    DATABASE_PW=your_database_pw
    DATABASE_URL=your_database_url
    DATABASE_USER=your_database_user
    USER_ID=your_user_id
    

Note: You can obtain the CLARIFAI_API_KEY by creating an account at Clarifai.

  1. Start the back-end server: Run the server:

    node server.js
  2. Start the front-end application: After started the server, in a separate terminal window, return to the smartbrain directory and run:

    npm start

Note: This project works in conjunction with the back-end application. To see how the two components interact, please visit the SmartBrain API Repository.