An easiest way to build README.md for your repository
ALREADYME is a multiplatform desktop application which create a README.md. If you input your github repository, it will analyze source codes of the repository and create README.md using AI. Let's create README.md of repository with only one-click.
- JDK
@17.x - MySQL
@8.x - Spring Boot
@2.7.2 - Spring Data JPA
- Spring Cloud for AWS
- commons-io
@2.6 - httpclient
@4.5.13
Before starting the server, Create application-dev.properties file in src/main/resources path and use that template.
# dev profiles
# MySQL Connection
spring.datasource.driver-class-name=
spring.datasource.url=
spring.datasource.username=
spring.datasource.password=
# JPA Setting
spring.jpa.database=
spring.jpa.database-platform=
spring.jpa.show-sql=
spring.jpa.hibernate.ddl-auto=
spring.jpa.properties.hibernate.format_sql=
spring.jpa.open-in-view=
# GITHUB Token
github.id=
github.token=
github.name=
github.email=
# AWS
cloud.aws.credentials.access-key=
cloud.aws.credentials.secret-key=
cloud.aws.region.static=
cloud.aws.s3.bucket=
cloud.aws.stack.auto=
# Ai-Server
ai-server.host=
- The start of creating
README.md- Enter GitHub repository URL
- Web URL
".git"URL
- Enter GitHub repository URL
- The process of creating
README.md- Loading view
- Repository cloning
- Real-time loading of the creation process
- Loading view
- The complete of creating
README.md- Donwload
README.md- Select a file download location
- Download markdown file
- Pull-Request
README.md- Pull-request to original repository from @ALREADYME-BOT repository
- Open web URL after pull-request is completed
- Donwload
ALREADME-BOT is that helps create README.md. The bot can fork the original repository. And add README.md generated by AI to the Forked repository. Finally, ALREADEME-BOT helps you pull-request the original repository.
