Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonwcfan authored Jan 30, 2023
1 parent fabc30d commit a0ff71a
Showing 1 changed file with 2 additions and 31 deletions.
33 changes: 2 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,12 @@
# OpenAI API Quickstart - Node.js example app
# Issue Classifier

This is an example pet name generator app used in the OpenAI API [quickstart tutorial](https://beta.openai.com/docs/quickstart). It uses the [Next.js](https://nextjs.org/) framework with [React](https://reactjs.org/). Check out the tutorial or follow the instructions below to get set up.

## Setup

1. If you don’t have Node.js installed, [install it from here](https://nodejs.org/en/) (Node.js version >= 14.6.0 required)

2. Clone this repository

3. Navigate into the project directory

```bash
$ cd openai-quickstart-node
```

4. Install the requirements

```bash
$ npm install
```

5. Make a copy of the example environment variables file

On Linux systems:
```bash
$ cp .env.example .env
```
On Windows:
```powershell
$ copy .env.example .env
```
6. Add your [API key](https://beta.openai.com/account/api-keys) to the newly created `.env` file

7. Run the app

```bash
$ npm run dev
```

You should now be able to access the app at [http://localhost:3000](http://localhost:3000)! For the full context behind this example app, check out the [tutorial](https://beta.openai.com/docs/quickstart).
You should now be able to access the app at [http://localhost:3000](http://localhost:3000)

0 comments on commit a0ff71a

Please sign in to comment.