feat: initial project commit
commit to push first working snapshot to codeberg
This commit is contained in:
commit
09b1054588
25 changed files with 1405 additions and 0 deletions
104
README.md
Normal file
104
README.md
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
# JakartaEE & Spring Boot Starter
|
||||
|
||||
This application is a GUI tool developed in Go using the Fyne framework (v2.5.4). It helps users set up a development environment for JakartaEE and Spring Boot projects by checking and installing necessary dependencies, and then allowing users to deploy starter projects.
|
||||
|
||||
## Features
|
||||
- *Dependency Check*: Verifies the installation of required tools (Visual Studio Code and Docker).
|
||||
|
||||
- *Automatic Installation*: Offers to install missing dependencies on supported platforms.
|
||||
|
||||
- *Project Selection*: Provides a list of starter projects for JakartaEE and Spring Boot.
|
||||
|
||||
- *Project Deployment*: Allows users to deploy selected projects and open them in Visual Studio Code with dev containers.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Go 1.23 or later
|
||||
|
||||
- Fyne v2.5.4
|
||||
|
||||
## Installation
|
||||
|
||||
### Option 1: Download Pre-built Binary
|
||||
|
||||
Go to the Releases page of this repository.
|
||||
|
||||
Download the appropriate binary for your operating system.
|
||||
|
||||
### Option 2: Build from Source
|
||||
|
||||
- Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourusername/jakartaee-springboot-starter.git
|
||||
```
|
||||
|
||||
Navigate to the project directory:
|
||||
|
||||
```bash
|
||||
cd jakartaee-springboot-starter
|
||||
```
|
||||
|
||||
Install dependencies:
|
||||
|
||||
The list of dependencies required for the development of Fyne Apps can be found at “https://docs.fyne.io/started/”.
|
||||
|
||||
```bash
|
||||
go mod tidy
|
||||
```
|
||||
|
||||
Build the application:
|
||||
|
||||
```bash
|
||||
go build
|
||||
```
|
||||
## Usage
|
||||
|
||||
Run the application:
|
||||
|
||||
If you downloaded a pre-built binary:
|
||||
|
||||
```bash
|
||||
./jakartaee-springboot-starter
|
||||
```
|
||||
|
||||
or by double-clicking the excutable.
|
||||
|
||||
If you built from source:
|
||||
|
||||
```bash
|
||||
./jakartaee-springboot-starter
|
||||
```
|
||||
|
||||
The application will launch a GUI window where you can:
|
||||
|
||||
1. Check and install dependencies (Visual Studio Code and Docker).
|
||||
2. Select a starter project from the available options.
|
||||
3. Deploy the selected project and open it in Visual Studio Code.
|
||||
|
||||
Project Structure
|
||||
|
||||
// TODO
|
||||
- main.go: Contains the entire application logic, including GUI setup, dependency checking, and project deployment.
|
||||
- projects/: Directory containing starter project templates.
|
||||
- projects.json: Configuration file for additional plugin projects.
|
||||
|
||||
## Customization
|
||||
|
||||
To add new starter projects:
|
||||
|
||||
1. Create a new project template in the projects/ directory.
|
||||
2. Add the project details to the projects.json file.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
License
|
||||
[Insert your chosen license here]
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- Fyne: https://fyne.io/
|
||||
- JakartaEE: https://jakarta.ee/
|
||||
- Spring Boot: https://spring.io/projects/spring-boot
|
||||
Loading…
Add table
Add a link
Reference in a new issue