FacePolls, is Serverless Facial Recognition voting application built entirely using AWS services and adheres to established best practices and uses the Event-Driven pattern.
Folder Structure • Services Used • How To Use • Architecture • Documentation • Related • License
This project contains source code for a serverless that can be deployed using the serverless framework. It also contains frontend code built using Next.js that can also be easily deployed or run locally. Also added are the architecture diagrams for the project.
- facial-vote-admin - Admin code for the application.
- facial-vote-architecture - Contains architectural diagram and workflows for the application
- facial-vote-backend - Contains the backend/serverless portion of the application built using the serverless framework
- facial-vote-frontend - Contains the frontend of the application built using Next.js
The application utilizes the event driven architecure and is built using AWS services powered by the serverless framework. The following are the AWS services explicitly used
- Amazon EventBridge
- Amazon S3
- Amazon DynamoDB
- Amazon SES
- AWS Lambda
- Amazon API Gateway
- AWS Step Functions
- AWS IoT
- Amazon Rekognition
- Amazon Cognito
- AWS CloudFormation
- AWS Amplify
- AWS STS
To clone and run this application, you'll need Git and Node.js v16+ (which comes with npm) installed on your computer. Also create an account with AWS, install the AWS CLI in locally, create an IAM user and add this user to AWS CLI as a profile. This profile user should have necessary permissions to deploy the backend section to AWS. Next, add required credentials to the .env file created from the command below. From your command line:
# Clone this repository
$ git clone https://github.com/chyke007/facial-vote.git
# Go into the repository
$ cd facial-vote
# Copy environment variable
$ cp facial-vote-admin/.env.example facial-vote-admin/.env && cp facial-vote-backend/.env.example facial-vote-backend/.env && cp facial-vote-frontend/.env.example facial-vote-frontend/.env
# Deploy backend (run from folder root)
$ npm i serverless -g
$ cd facial-vote-backend && npm i && serverless deploy
# Remove backend resources (run from folder root)
$ cd facial-vote-backend && sls remove
# Run Frontend (run from folder root)
$ cd facial-vote-frontend && npm i && npm run dev
# Run Admin (run from folder root)
$ cd facial-vote-admin && npm i && npm run dev
You can find an article that explains the project here
MIT
chibuikenwa.com · GitHub @chyke007 · LinkedIn @chibuikenwachukwu