Skip to content

Unfake-Official/web

Repository files navigation

πŸ’» Unfake

tailwind next typescript react

About β€’ Getting Started β€’ App Routes β€’ Contribute

πŸ“Œ About the project

The growing evolution of artificial intelligence (A.I.) tools is making them increasingly efficient and globally accessible. However, some of these technologies can be harmful if used maliciously, and that includes deepfakes. Deepfakes are a type of synthetic media that generates realistic content and has the potential to clone an individual's identity, using it to spread fake news, damage their reputation and promote fraud and security breaches. Thus, there is a need for ways to verify whether a piece of media is real or artificially synthesized. However, even though there are technologies that meet this need, the detection of audio deepfakes is still a challenge, considering that it is not as effective when it comes to speech in Portuguese and has questionable effectiveness in audio with the presence of noise. In this sense, Unfake aims to develop an A.I. model capable of identifying whether an audio contains human or synthetic speech. In this way, we hope to make it possible for lay users to identify deepfakes in a robust and effective way, contributing to a safer and more reliable digital environment, as well as encouraging future research in the area using the data obtained in the project.


πŸš€ Getting started

Prerequisites

Here is a list of all prerequisites necessary for running the project locally:

Cloning

git clone https://github.com/Unfake-Official/web.git

Starting

Firstly, go to the project's directory:

cd unfake-web

Next, install all dependencies:

pnpm install

Finally, run the development server:

pnpm run dev

Open http://localhost:3000 with your browser to see the result.

πŸ“ Application Routes

Here is the list of the routes of the product and what they do. ​

route description
/ landing page that contains some of the product informations
/authors page that contains information about those who collaborated to the project
/about-project markdown content pages containing more detailed info about the project
/classify page that receives user's audio as input and sends then to the API in order to classify them

Classifying an audio

Here is the request body that the website sends to the API.

{
  audio: file.wav
}

The request sends an audio file through the body. It must have .wav extension. As a response, the API sends the prediction and the accuracy of it, as following:

{
  prediction: string,
  accuracy: number
}

πŸ“« Contribute

If you want to somehow contribute to this project, start by creating a branch named as follow. Then, make your changes and follow commit patterns. Finally, open an pull request.

  1. git clone https://github.com/Unfake-Official/web.git
  2. git checkout -b feature/NAME
  3. Follow commit patterns
  4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

πŸ“ How to create a Pull Request

πŸ’Ύ Commit pattern

About

πŸ’» The simple yet useful Unfake's front-end

Resources

Stars

Watchers

Forks

Languages