Readify is a web application that enables you to generate production-ready README files directly from your GitHub repositories.
- Generate README Files: Automatically generates README documentation for your GitHub projects.
- View Previous Generations: Access and manage previously generated README documents with ease.
- User Authentication: Secure user sessions managed through Supabase.
- Frontend: React, Next.js
- Styling: Tailwind CSS
- Backend: Supabase
- Others: TypeScript
To get started with Readify, clone the repository and install the dependencies:
git clone https://github.com/JesseJohn7/readify.git
cd readify
npm installTo run the application in development mode, use the following command:
npm run devVisit http://localhost:3000 in your browser to view the app.
The README generation can be accessed through an interface where you can select a GitHub repository. The necessary API calls are handled on the backend, ensuring user authentication through Supabase.
GET /api/repos
Fetches the user's GitHub repositories (requires authentication).
GET /api/history
Retrieves the history of previously generated README files for the authenticated user.
DELETE /api/history
Deletes a selected README history entry of the authenticated user.
- Improve UI/UX based on user feedback.
- Implement additional features for README customization.
- Support for more markdown elements in the generated READMEs.
This project is licensed under the MIT License. See the LICENSE file for details.
You can view a live demo of Readify at readify-delta.vercel.app.
Contributions are welcome! Please submit a pull request for any changes or enhancements.