Home page with animated gradient background.
Uploads page where you can upload your files
Editor page where you will see your generated code with built-in editor.

Inspiration

The Problem we see in the developer community is whenever a developer creates a project he has to spend time writing the whole documentation of the code, and sometimes when the deadlines are close, we forget sections to be added to our readme files, and to reduce the time of writing project readme our ReadMeAI comes into play.

What it does

The task of ReadMeAI is to convert code and description into good-looking readme's. User can upload their code files and can describe their code in a few words and the ReadMeAI generates a markdown code for your readme. You will get a built-in editor to format your readme according to your needs and then you can download your readme in markdown and HTML format.

How we built it

We have used the Legendary Javascript programming language to build this project. For the backend, we have used javascript runtime node.js and express.js framework and For the frontend, we have used core HTML, CSS, and Javascript. For the generation of the readme, we are using
Google PaLM 2. We have also used Docker to create a custom image for our project.

Challenges we ran into

The first challenge we faced was Choosing the perfect AI. We can't go with Open AI as it is paid now, we want something that is free for developers and open to use for everyone that's why we selected Google PaLM 2 for our project. Another challenge we faced was the GitHub collaboration workflow, we learned how difficult it is when multiple people work on the same project.

Accomplishments that we're proud of

The BIGGEST Accomplishment we are proud of is that we've solved the core need of any developer he faced after building any project Documentation. We hope that the other developers will contribute to this open-source project and make it better and more reliable for other Developers, so they can work more effectively and more efficient way.

What we learned

The Biggest learning we learned from this project is how to work in a team. We learned about how to prompt an AI to return desirable Results, as a team we learned so many things from each other too.

What's next for ReadmeAI

Our Future Plans for ReadMeAI are:

GitHub Integration: User can integrate their GitHub accounts can create readme for any existing repo.
Custom Templates: Users will be able to create their own output templates and can use templates built by other users from Template Marketplace.
More Trained Model: We are currently focusing on changing the AI model to llama and we will trained it according to our project and needs.
Better Technologies and Architecture: We will switch our current tech stack to more new technologies.