QR Code Generator Tool

Introduction

The QR Code Generator is a comprehensive tool designed to create QR codes effortlessly. It uses a stable diffusion model from replicate to generate the QR Code, and allows downloading the QR code. It takes URL as an input and prompt for the type of QR to be generated.

Quickstart Guide

Installation

1. Clone the repository:

   terminal

   git clone https://github.com/1811-Labs-LLC/BuilderKit-Pro.git [YOUR_APP_NAME]
    
   cd [YOUR_APP_NAME]
    
   git checkout qr-code-generation

   Remove the origin remote to ensure that you can work locally without pushing the changes back to the original repository.

   terminal

   git remote remove origin

   However, note that after removing the remote, you won't be able to switch between the branches, so you'll need to clone the repository again if you want to work on another branch.

2. Install dependencies:

   terminal

   npm install

3. Environment Variables:

   Copy the required variables from .env.example to .env.local as mentioned and update the values.

   terminal

   cp .env.example .env.local

   Or, manually create a .env.local file in the root directory with the following env variables (make sure to update the values with your actual keys):

   .env.local

   # Host
   NEXT_PUBLIC_APP_URL=<your-app-url>
    
   # Supabase
   NEXT_PUBLIC_SUPABASE_URL=<your-supabase-url>
   NEXT_PUBLIC_SUPABASE_ANON_KEY=<your-supabase-anon-key>
   SUPABASE_SERVICE_ROLE_KEY=<your-supabase-service-role-key>
    
   # Replicate
   REPLICATE_API_TOKEN=<your-replicate-api-key>
    
   # Google Analytics
   NEXT_PUBLIC_GOOGLE_ANALYTICS_KEY=<your-google-analytics-key>

Setup Supabase

1. Create Qr Code Generator Table in Supabase:

   sql

   -- Create a table for AI QR Code Generation
   create table qr_code_generations (
      id uuid not null default uuid_generate_v4 (),
      created_at timestamp with time zone not null default now(),
      user_id uuid null,
      url text not null,
      prompt text not null,
      image_url text null,
      error text null,
      constraint qr_code_generations_pkey primary key (id),
      constraint qr_code_generations_user_id_fkey foreign key (user_id) references users (id)
   );
    
   -- Set up Row Level Security (RLS)
   alter table qr_code_generations
   enable row level security;
    
   create policy "Users can insert their own row." on qr_code_generations
   for insert with check (auth.uid() = user_id);
    
   create policy "Users can update own row" on qr_code_generations
   for update using (auth.uid() = user_id);
    
   create policy "Users can read own row" on qr_code_generations
   for select using (auth.uid() = user_id);
    
   -- Optional: Add policy to allow users to delete their own row
   create policy "Users can delete own row" on qr_code_generations
   for delete using (auth.uid() = user_id);

   For all the tables, we enable the RLS policy by default with necessary permissions as mentioned in the script.

2. Sync Supabase Types:

   To sync the supabase table schema with your project follow the steps here.

Running the Application

1. Run the development server:

   terminal

   npm run dev

   This will start the development server on http://localhost:3000 (opens in a new tab).

2. Build for production:

   terminal

   npm run build

   This command compiles the application for production usage.

3. Start the production server:

   terminal

   npm start

   This will start the application in production mode.

Additional Scripts

• Prepare Husky for Git hooks:

  terminal

  npm run prepare

• Validate the code with Linting, Formatting & Typecheck:

  terminal

  npm run validate

Make the tool publicly accessible by removing the login process

1. Go to src/app/(dashboard)/layout.tsx and comment the following section from line:15 to line:20 as shown in the image below:

   

2. Now, go to src/app/(dashboard)/generate/actions.ts and comment the following section from line:13 to line:15 as shown in the image below:

   

These sections reads the user data and checks if the user is signed in or not. By commenting this section it does not check the user validation.

Requirements

• Node.js: Download and install from here (opens in a new tab).
• Supabase: Check out Supabase Setup Documentation to get all the required details.
• Replicate API Key: Create an account on Replicate (opens in a new tab) to get the api token.