Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 4.03 KB

README.md

File metadata and controls

54 lines (42 loc) · 4.03 KB
Raw

SmartBrain API - Back-End Server 🌐⚙️

Personal Description:
SmartBrain API serves as the back-end component for the SmartBrain Face Detection App. Built using Node.js and Express.js, this server provides a robust architecture to handle API requests and manage user interactions with the database.

Key Features 🌟

  • API Endpoints: The server exposes several API endpoints for user authentication, image processing, and data retrieval.
  • PostgreSQL Database Integration: The app interfaces with a PostgreSQL database to store user data and application state efficiently.
  • Authentication: User authentication is managed securely, allowing users to sign in and track their activity.

Project Objectives 🏆

SmartBrain API is designed to demonstrate:

  • Effective use of Node.js and Express.js for server-side development.
  • Integration of PostgreSQL for data management.
  • Implementation of RESTful API principles.

Setup & Run 💻

  1. Clone the repository:

    git clone https://github.com/Hokkyokukou/smart-brain-api.git
cd smart-brain-api

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env file in the root 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 server: 
    node server.js

Note: The SmartBrain API works in conjunction with the front end application. To see how the two components interact, please visit the SmartBrain Front End Repository.