WRITEME

This README was automatically generated by WRITEME itself, demonstrating the application's AI-powered documentation capabilities.

Project Description

WRITEME is a Spring Boot web application designed to assist developers by generating comprehensive README files for their Java projects. By uploading project files, WRITEME analyzes the codebase and formulates prompts that are sent to Spring AI, utilizing an OpenAI model to generate informative documentation. This tool streamlines the process of creating essential project documentation, saving time and enhancing clarity. Future plans include support for additional programming languages.

Technologies Used

• Java: The primary programming language used for development.
• Spring Boot: Framework for building the web application.
• OpenAI API: Utilized for generating README content based on code analysis.
• Maven: Dependency management and build automation.
• Docker: Containerization tool for deploying the application.
• Thymeleaf: Used as the templating engine for rendering HTML views.

Project Structure

writeme
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── seanlee
│   │   │           └── writeme
│   │   │               ├── AiService.java
│   │   │               ├── DocumentationController.java
│   │   │               ├── DocumentationService.java
│   │   │               └── WritemeApplication.java
│   │   ├── resources
│   │   │   ├── application.properties
│   │   │   ├── static
│   │   │   │   └── style.css
│   │   │   └── templates
│   │   │       └── index.html
│   ├── test
│   │   └── java
│   │       └── com
│   │           └── seanlee
│   │               └── writeme
│   │                   └── WritemeApplicationTests.java
├── Dockerfile
├── pom.xml
└── README.md

Main Features

• File Upload: Users can upload project files for analysis.
• Code Analysis: The application inspects the codebase to extract relevant information.
• AI-Generated Documentation: Leverages AI to generate detailed README files based on the analysis.
• RESTful API: Provides endpoints for interacting with the application.
• Future Language Support: Plans to expand functionality to support additional programming languages.

How to Run/Setup

Running Locally

1. Clone the repository:

   git clone https://github.com/seansjlee/writeme.git
   cd writeme

2. Build the project using Maven:

   mvn clean install

3. Run the application:

   mvn spring-boot:run

4. Access the application at http://localhost:8080.

Running with Docker

1. Build the Docker image:

   docker build -t writeme .

2. Run the Docker container:

   docker run -p 8080:8080 writeme

3. Access the application at http://localhost:8080.

API Endpoints

GET /

• Description: Displays the main interface for uploading a project folder.

POST /generate-readme

• Description: Accepts the uploaded project folder.
• Request Body: Contains the uploaded project files in a suitable format.
• Response: Returns the generated README file in response.

Conclusion

WRITEME simplifies the documentation process for developers by leveraging advanced AI capabilities to generate clear and concise README files. With its easy setup and user-friendly interface, WRITEME is a valuable tool for any developer looking to enhance their project documentation.

Feel free to explore the codebase and contribute to the project! For any issues or feature requests, please open an issue on the GitHub repository.