possumop / face-model-api

Backend API Service for Face Model. Built with Express.js & PostgreSQL database hosted on Heroku.

Getting Started

The face-model-api is a backend api for the project face-model with backend authentication and a PostgreSQL database, hosted on Heroku. Get response from Clarifai API and see it visualize. More on Clarifai's face-detection model can be found here.

Developing

Fork the repository using this guide, then clone it locally.

git clone https://github.com/harshcut/face-model-api
cd face-model-api
yarn install

You can now run the Express Server on your localhost.

yarn start

PostgreSQL Database

This project uses PostgreSQL database which is a powerful, open source object-relational database system. It uses and extends the SQL language combined with many features that safely store and scale the most complicated data workloads.

Create Database

CREATE DATABASE creates a new PostgreSQL database.

CREATE DATABASE "face-model-storage";

Create Tables

To create a new table, you use the CREATE TABLE statement. Make sure to create the tables in the face-model-storage database.

CREATE TABLE "face-model-registry" (
  id VARCHAR(36) NOT NULL PRIMARY KEY,
  first_name TEXT NOT NULL,
  last_name TEXT NOT NULL,
  email TEXT NOT NULL UNIQUE,
  password TEXT NOT NULL,
  entries INTEGER NOT NULL DEFAULT 0
);

Registered user credentials are stored in face-model-registry and their detection history is logged in face-model-history.

CREATE TABLE "face-model-history" (
  serial SERIAL NOT NULL PRIMARY KEY,
  timestamp TIMESTAMP NOT NULL,
  id VARCHAR(36) NOT NULL,
  email TEXT NOT NULL,
  image TEXT NOT NULL
);

Replace values of user and password in index.js according to your database configuration.

{
  host: "127.0.0.1",
  user: "postgres",
  password: "post",
  database: "face-model-storage",
}

Environment Variables

Create a .env file in the root of the project and add the Clarifai API Key. The value assigned for API_KEY below is fake and will not work. To create your own api key, Sign Up for a Clarifai account and create an application. For more information visit Clarifi's Quick Start Guide.

Assign your client's URL to ORIGIN to prevent cross-domain based attacks. Note that it is an optional variable and can be skipped, without creating any extra modifications.

To run the project in development mode and connect to a local database, set DEV to true. Note that the variable assigned is a string and not a boolean.

API_KEY=3d20e9dea9a6f5a297ac3b1a
ORIGIN=http://localhost:3001
DEV=true

License

This project is licensed under the MIT License.