Skip to content

Latest commit

 

History

History
33 lines (28 loc) · 1.56 KB

README.md

File metadata and controls

33 lines (28 loc) · 1.56 KB
Raw

verifeye

A prototype showcasing the proposed UI/UX design that will encourage users to verify contents in short-form video platforms like TikTok, Instagram Reels, and YouTube Shorts.

Prerequisites

The following are the frameworks and tools that you must be familiar with to be able to contribute to this project:

  1. JavaScript and TypeScript
  2. Node.js or Bun (we personally prefer Bun)
  3. React
  4. Next.js
  5. Tailwind CSS
  6. Vercel

Running Locally

  1. Run the following in your terminal starting with cloning the repository:
git clone https://github.com/cifrelabs/verifeye.git
  1. Install dependencies:
npm install    # or bun install
  1. Create a .env.local file at the root of the project with the contents of .env.template and fill in the keys.

Important

The project will not run properly without the environment variables. Seek assistance from other developers in the team if you don't have the necessary values for the variables.

  1. Run the development server:
npm run dev    # or bun dev

Deployment

Once changes have been made, you can push commits to the main branch and Vercel will take care of the building and deployment. You can view the deployed progressive web application at verifeye.vercel.app.