https://github.com/trypear/pear-landing-page
Landing page for PearAI, the Open Source AI-Powered Code Editor
https://github.com/trypear/pear-landing-page
ai codeeditor open-source
Last synced: about 1 year ago
JSON representation
Landing page for PearAI, the Open Source AI-Powered Code Editor
- Host: GitHub
- URL: https://github.com/trypear/pear-landing-page
- Owner: trypear
- License: apache-2.0
- Created: 2024-04-19T02:39:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T08:17:34.000Z (over 1 year ago)
- Last Synced: 2024-10-24T12:03:02.797Z (over 1 year ago)
- Topics: ai, codeeditor, open-source
- Language: TypeScript
- Homepage: https://trypear.ai
- Size: 99.9 MB
- Stars: 59
- Watchers: 6
- Forks: 83
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
PearAI Landing Page
The Open Source AI-powered code editor
Explore the Website »
Report Bug
·
Request Feature
---
## Table of Contents
- [About the Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Environment Variables](#environment-variables-description)
- [Usage](#usage)
- [Contributing](#contributing)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
## About The Project
This is the landing page for [PearAI:](https://trypear.ai) the Open Source AI-powered code editor.
### Built With
- [![nextjs][nextjs]][nextjs-url]
- [![vercel][vercel]][vercel-url]
- [![tailwindcss][tailwindcss]][tailwindcss-url]
- [![typescript][typescript]][typescripturl]
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- Yarn
```sh
npm install --global yarn
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/trypear/pear-landing-page.git
```
2. Install NPM packages
```sh
yarn install
```
### 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
```sh
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
## 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
2. Clone the repo
```sh
git clone https://github.com//pear-landing-page.git
```
3. Navigate to the project directory
```sh
cd pear-landing-page
```
4. Create a new branch
```sh
git checkout -b my-new-branch
```
5. Install dependencies
```sh
yarn install
```
## Contact
- [Discord](https://discord.com/invite/7QMraJUsQt)
- Email - pear@trypear.ai
[typescript]: https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white
[typescripturl]: https://www.typescriptlang.org/
[vercel]: https://img.shields.io/badge/Vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white
[vercel-url]: https://vercel.com/
[nextjs]: https://img.shields.io/badge/Next.js-%23000000.svg?style=for-the-badge&logo=next.js&logoColor=white
[nextjs-url]: https://nextjs.org/
[tailwindcss]: https://img.shields.io/badge/Tailwind_CSS-%231a202c.svg?style=for-the-badge&logo=tailwind-css&logoColor=white
[tailwindcss-url]: https://tailwindcss.com/
[discord]: https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=discord&logoColor=white