/pear-landing-page

Landing page for PearAI, the Open Source AI-Powered Code Editor

Primary LanguageTypeScript

PearAI Logo

PearAI Landing Page

The Open Source AI-powered code editor
Explore the Website »

Report Bug · Request Feature

Table of Contents

About The Project

This is the landing page for PearAI: the Open Source AI-powered code editor. This product is managed by Nang and Pan.

(back to top)

Built With

  • nextjs
  • vercel
  • tailwindcss
  • typescript

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Yarn 
    npm install --global yarn

Installation

  1. Clone the repo 
    git clone https://github.com/trypear/pear-landing-page.git
  2. Install NPM packages 
    yarn install

    (back to top)

Project Configuration

This project requires environment variables to be set up in a .env.local file for proper configuration and operation. Below are the required environment variables and instructions on how to set them up.

Required Environment Variables

  1. NEXT_PUBLIC_SUPABASE_URL
  2. NEXT_PUBLIC_SUPABASE_ANON_KEY

Environment Variables Description

  • NEXT_PUBLIC_SUPABASE_URL: This is the URL of your Supabase project.

    Example: NEXT_PUBLIC_SUPABASE_URL=https://xyzcompany.supabase.co

  • NEXT_PUBLIC_SUPABASE_ANON_KEY: This is the anonymous public key for your Supabase project. This key allows your frontend application to interact with the Supabase backend.

    Example: NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key

  • NEXT_PUBLIC_VERCEL_URL: This is the URL to which users will be redirected after certain actions, such as authentication. During local development, this is typically http://localhost:3000. For Vercel preview/dev deployments, it will be whatever URL Vercel generates. For production, we should use NEXT_PUBLIC_SITE_URL instead. Both NEXT_PUBLIC_SITE_URL and NEXT_PUBLIC_VERCEL_URL are auto-generated by Vercel, so no need to worry about it.

    Example: NEXT_PUBLIC_REDIRECT_URL=http://localhost:3000

Usage

To run the project locally:

  1. Start the development server 
    yarn dev
  2. Visit http://localhost:3000 in your browser.

Recommended Extensions

  • Prettier
    • Open your command palette, choose your default formatter to be Prettier, and enable format on save.
  • ESLint
    • When you push a commit, we have a pre-commit hook that automatically runs prettier, eslint, and builds your project to make sure everything is ok.
  • JavaScript and TypeScript Nightly

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request.

  1. Fork the repo 
    git clone https://github.com/trypear/pear-landing-page.git
  2. Clone the repo 
    git clone https://github.com/<USERNAME>/pear-landing-page.git
  3. Navigate to the project directory 
    cd pear-landing-page
  4. Create a new branch 
    git checkout -b my-new-branch
  5. Install dependencies 
    yarn install

(back to top)

Contact

(back to top)