Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
steven-tey authored Apr 13, 2023
1 parent 5e9db8e commit 7574b2a
Showing 1 changed file with 36 additions and 22 deletions.
58 changes: 36 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,50 @@
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).
<a href="https://github.com/steven-tey/weathergpt">
<img src="https://user-images.githubusercontent.com/28986134/231839928-5d9035ea-5fd1-44b8-81a6-4a8d4bea1970.png" alt="Logo">
</a>

## Getting Started
<h1 align="center">WeatherGPT</h3>

First, run the development server:
<p align="center">
The ultimate ChatGPT Plugin starter template.
</p>

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
<p align="center">
<a href="#introduction"><strong>Introduction</strong></a> ·
<a href="#features"><strong>Features</strong></a> ·
<a href="#try-the-plugin"><strong>Try the Plugin</strong></a> ·
<a href="#deploy-your-own"><strong>Deploy Your Own</strong></a>
</p>
<br/>

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Introduction

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
WeatherGPT is a ChatGPT Plugin to get the weather of any given location. Built with Next.js and served from Vercel's Edge Network.

[http://localhost:3000/api/hello](http://localhost:3000/api/hello) is an endpoint that uses [Route Handlers](https://beta.nextjs.org/docs/routing/route-handlers). This endpoint can be edited in `app/api/hello/route.ts`.
https://user-images.githubusercontent.com/28986134/231841036-80da6d5b-b1dd-46e8-881e-4034529bcd1e.mp4

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Features

## Learn More
- AI-Plugin & OpenAPI JSON specs
- Returns a link to a dynamic Next.js route
- Nextjs 13 App Router
- Edge Route Handlers for returning weather data
- Metadata API for SEO tags
- `ImageResponse` API for dynamic OG images at the edge

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.
## Try the Plugin

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
If you have access to Plugins, you can try this plugin out!

## Deploy on Vercel
1. Go to the Plugin Store
2. Click "Install an unverified plugin"
3. Enter "weathergpt.vercel.app"
4. Click "Install".

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.
https://user-images.githubusercontent.com/28986134/231842599-ab80ccc2-b1c2-4d24-bdfc-c023eebdf320.mp4

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## Deploy Your Own

You can deploy your own hosted version of this plugin to Vercel with one-click:

[![Deploy with Vercel](https://vercel.com/button)](https://dub.sh/deploy)

1 comment on commit 7574b2a

@vercel
Copy link

@vercel vercel bot commented on 7574b2a Apr 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

weathergpt – ./

weathergpt.vercel.app
weathergpt-git-main-vercel-labs.vercel.app
weathergpt-vercel-labs.vercel.app

Please sign in to comment.