Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sashenjayathilaka/chatgpt-clone
ChatGPT Clone with REACT! (Next.js 13, Firebase, Tailwind CSS, TypeScript, API endpoints in Next.js, ChatGPT models, Dynamic page routing in Next.js 13, App folder structure, NextAuth.js, Google Authentication)
https://github.com/sashenjayathilaka/chatgpt-clone
autoprefixer chatgpt-api eslint-config-next firebase-admin firebase-firestore framer-motion google-authentication learn next-auth next-js openai postcss react-firebase-hooks react-hot-toast react-select reactjs swr tailwind-css typescript
Last synced: 14 days ago
JSON representation
ChatGPT Clone with REACT! (Next.js 13, Firebase, Tailwind CSS, TypeScript, API endpoints in Next.js, ChatGPT models, Dynamic page routing in Next.js 13, App folder structure, NextAuth.js, Google Authentication)
- Host: GitHub
- URL: https://github.com/sashenjayathilaka/chatgpt-clone
- Owner: SashenJayathilaka
- License: mit
- Created: 2022-07-03T03:25:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-02T15:56:55.000Z (almost 2 years ago)
- Last Synced: 2025-01-09T03:36:17.056Z (22 days ago)
- Topics: autoprefixer, chatgpt-api, eslint-config-next, firebase-admin, firebase-firestore, framer-motion, google-authentication, learn, next-auth, next-js, openai, postcss, react-firebase-hooks, react-hot-toast, react-select, reactjs, swr, tailwind-css, typescript
- Language: TypeScript
- Homepage: https://chatgpt-sclone.vercel.app
- Size: 629 KB
- Stars: 199
- Watchers: 2
- Forks: 77
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
ChatGPT Clone with React.JS
ChatGPT Clone with REACT! (Next.js 13, Firebase, Tailwind CSS, TypeScript, API endpoints in Next.js, ChatGPT models, Dynamic page routing in Next.js 13, App folder structure, NextAuth.js, Google Authentication).
View Demo
·
Documentation
·
Report Bug
·
Request Feature
## :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Tech Stack](#space_invader-tech-stack)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Installation](#gear-installation)
- [Run Locally](#running-run-locally)
- [Deployment](#triangular_flag_on_post-deployment)
- [Contact](#handshake-contact)
## :star2: About the Project
### :camera: Screenshots
## LIVE DEMO 💥
### :space_invader: Tech Stack
Client
Backend
## :toolbox: Getting Started
### :bangbang: Prerequisites
- Sign up for a Firebase account HERE
- Install Node JS in your computer HERE
- Get OpenAi Api key HERE
### :key: Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`OPENAI_API_KEY`
`NEXTAUTH_URL`
`GOOGLE_CLIENT_ID`
`NEXT_PUBLIC_SECRET`
`GOOGLE_CLIENT_SECRET`
`NEXT_PUBLIC_BASE_URL`
`NEXT_PUBLIC_FIREBASE_APP_ID`
`NEXT_PUBLIC_FIREBASE_API_KEY`
`NEXT_PUBLIC_FIREBASE_PROJECT_ID`
`NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN`
`NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET`
`NEXT_PUBLIC_FIREBASE_MESSAGING_SET`
`FIREBASE_SERVICE_ACCOUNT_KEY`
### :gear: Installation
Install my-project with npm
```
npx create-next-app@latest my-project --typescript
```
```
cd my-project
```
Install dependencies
### :test_tube: Install Tailwind CSS with Next.js
#### Install Tailwind CSS
Install tailwindcss and its peer dependencies via npm, and then run the init command to generate both `tailwind.config.js` and `postcss.config.js`.
```
npm install -D tailwindcss postcss autoprefixer
```
```
npx tailwindcss init -p
```
#### Configure your template paths
Add the paths to all of your template files in your `tailwind.config.js` file.
```js
/** @type {import('tailwindcss').Config} */
module.exports = {
content: [
"./app/**/*.{js,ts,jsx,tsx}",
"./pages/**/*.{js,ts,jsx,tsx}",
"./components/**/*.{js,ts,jsx,tsx}",
// Or if using `src` directory:
"./src/**/*.{js,ts,jsx,tsx}",
],
theme: {
extend: {},
},
plugins: [],
}
```
#### Add the Tailwind directives to your CSS
Add the `@tailwind` directives for each of Tailwind’s layers to your `./styles/globals.css` file.
```css
@tailwind base;
@tailwind components;
@tailwind utilities;
```
Install dependencies
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/SashenJayathilaka/ChatGPT-Clone.git
```
```bash
npm install
```
## Getting Started
Start the server
First, run the development server:
```bash
npm run dev
```
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
Install dependencies
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
### Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
### :triangular_flag_on_post: Deployment
To deploy this project run
##### Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## :handshake: Contact
Your Name - [@twitter_handle](https://twitter.com/SashenHasinduJ) - [email protected]
Project Link: [https://github.com/SashenJayathilaka/ChatGPT-Clone.git](https://github.com/SashenJayathilaka/ChatGPT-Clone.git)