https://github.com/jongan69/ai-readme
Use AI to generate a readme for your code
https://github.com/jongan69/ai-readme
Last synced: 2 months ago
JSON representation
Use AI to generate a readme for your code
- Host: GitHub
- URL: https://github.com/jongan69/ai-readme
- Owner: jongan69
- Created: 2023-01-29T22:15:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T13:46:36.000Z (about 2 years ago)
- Last Synced: 2025-02-26T22:14:10.769Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://ai-readme.vercel.app
- Size: 121 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AI Readme
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.
## Getting Started
### First, Create your .env
`cp .env.example .env`
and then
visit [here](https://openai.com/api/) for an API Key
copy your key to `OPENAI_API_KEY=` in `.env`
### Second run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
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.
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
### 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!
### 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.