This repository contains a simple AI readme generator that uses OpenAI's GPT-3 API to generate a well-documented readme in markdown format.
To use the AI readme generator, you need to have a OpenAI API Key. If you don't have one, you can sign up for the OpenAI API Beta program here.
After you have an API Key, paste it in your .env, and you can use the AI readme generator by simply running the Nextjs Application in your browser.
cp .env.example .env
and then
visit here for an API Key
copy your key to OPENAI_API_KEY= in .env
npm run dev
# or
yarn dev
# or
pnpm devOpen 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 can be accessed on 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 instead of React pages.
This project uses next/font to automatically optimize and load Inter, a custom Google Font.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.