https://github.com/labib2003/aws-rekognition-nodejs
A simple face recognition auth system based on AWS Rekognition
https://github.com/labib2003/aws-rekognition-nodejs
aws awsrekognition expressjs face-recognition nodejs prisma-orm
Last synced: 6 months ago
JSON representation
A simple face recognition auth system based on AWS Rekognition
- Host: GitHub
- URL: https://github.com/labib2003/aws-rekognition-nodejs
- Owner: Labib2003
- Created: 2024-08-17T13:19:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-17T15:56:09.000Z (about 1 year ago)
- Last Synced: 2025-01-30T04:25:54.587Z (8 months ago)
- Topics: aws, awsrekognition, expressjs, face-recognition, nodejs, prisma-orm
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AWS Rekognition Demo Project
This project demonstrates the use of AWS Rekognition to manage and verify faces in a collection. The core functionalities include adding a new face with an employee ID, checking if a face matches existing entries, and deleting a face from the collection. Prisma is used as the database for managing employee records and face IDs.
## Features
- **Save a New Face `POST /save`:** Add a new face to the AWS Rekognition collection, ensuring that no duplicate employee ID or face exists.
- **Check Match `POST /checkmatch`:** Verify if a given face matches any face in the AWS Rekognition collection.
- **Delete Face `DELETE /delete/:** Remove a face from AWS Rekognition using the associated employee ID.
## Setup Instructions
### Prerequisites
1. **AWS Account**: Ensure you have an AWS account with Rekognition service enabled.
2. **Environment Variables**: Set the following environment variables in a `.env` file:
- `AWS_ACCESS_KEY_ID`: Your AWS access key.
- `AWS_SECRET_ACCESS_KEY`: Your AWS secret key.
- `REKOGNITION_COLLECTION_ID`: The ID of your Rekognition face collection.
3. **Database**: Set up Prisma with a database (e.g., PostgreSQL) to manage employee records.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Labib2003/aws-rekognition-nodejs.git
cd aws-rekognition-nodejs
```
2. Install dependencies:
```bash
npm install
```
3. Set up the environment variables by creating a `.env` file and adding the necessary AWS and Prisma configurations.
4. Run Prisma migrations to set up the database schema:
```bash
npx prisma db push
```
5. Start the application:
```bash
npm start
```
### Running the Application
Once the application is running, use an API client like Postman to test the following endpoints:
- `POST /save`: Save a new face.
- `POST /checkmatch`: Check if a face matches.
- `DELETE /delete/:id`: Delete a face by employee ID.
## Error Handling
- **409 Conflict**: Returned when there are conflicts such as duplicate employee IDs or faces.
- **404 Not Found**: Returned when resources (faces or employee IDs) are not found.
- **500 Internal Server Error**: Returned for any unhandled errors.
## Technologies Used
- **Express**: Web framework for API routing.
- **Prisma**: ORM for managing the database.
- **AWS Rekognition**: For face detection and recognition.