Skip to content

Dee-Codez/READMEasy

Repository files navigation

READMEasy

project-image

Ever thought of starting the documentation of your project as troublesome. Well consider them days of the past coz now READMEasy has come to your rescue!! With our product you now won't ever have to start writing docs from scratch and instead go off with an awesome AI-Generated boilerplate content with full customization capabilities. This not only provides with a generic template but also uses context of whatever your project provides be it deployement URIs languages Dockerfiles and even takes into account all technical dependencies!!

🚀 Demo

https://readmeasy.vercel.app/

Project Screenshots:


Landing Page

Screenshot 2024-06-05 175333

User Page

Screenshot 2024-06-05 182116

Loading Page

Screenshot 2024-06-05 180858

Editor Page

Screenshot 2024-06-05 180333


🧐 Features

Here're some of the project's techincal features:

  • Keeps track of previously generated readme's for ease of access
  • Promise based UI Handling so every loading is intricate with completion percentages
  • Gets Context of whatever is publically accesible via Github
  • Takes into account the dependencies of every project

💻 Built with

Technologies used in the project:

  • NextJS
  • TypeScript
  • TailwindCSS
  • Puppeteer
  • PostgreSQL
  • PrismaORM

💖Like my work?

Contact me at

[email protected]

About

Making Readme's Now Easier :)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published