Skip to content

Commit

Permalink
Merge pull request #1 from tolgayayci/dev
Browse files Browse the repository at this point in the history
v0.1.0
  • Loading branch information
tolgayayci authored Feb 14, 2024
2 parents fa64f9c + 3bf78a4 commit 414bc75
Show file tree
Hide file tree
Showing 103 changed files with 14,328 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules
*.log
.next
app
dist
40 changes: 40 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Nextron: Main",
"type": "node",
"request": "attach",
"protocol": "inspector",
"port": 9292,
"skipFiles": ["<node_internals>/**"],
"sourceMapPathOverrides": {
"webpack:///./~/*": "${workspaceFolder}/node_modules/*",
"webpack:///./*": "${workspaceFolder}/*",
"webpack:///*": "*"
}
},
{
"name": "Nextron: Renderer",
"type": "chrome",
"request": "attach",
"port": 5858,
"timeout": 10000,
"urlFilter": "http://localhost:*",
"webRoot": "${workspaceFolder}/app",
"sourceMapPathOverrides": {
"webpack:///./src/*": "${webRoot}/*"
}
}
],
"compounds": [
{
"name": "Nextron: All",
"preLaunchTask": "dev",
"configurations": ["Nextron: Main", "Nextron: Renderer"]
}
]
}
21 changes: 21 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "dev",
"isBackground": true,
"problemMatcher": {
"owner": "custom",
"pattern": {
"regexp": ""
},
"background": {
"beginsPattern": "started server",
"endsPattern": "Debugger listening on"
}
},
"label": "dev"
}
]
}
75 changes: 74 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,74 @@
# soroban-cli-gui
# SOROBAN CLI GUI

SOROBAN CLI GUI is a cross platform, electron based application designed to streamline the use of the Soroban CLI. It offers a user-friendly interface for managing projects, identities, networks, and contract methods with ease.

---

## Installation

To use this application, you must have soroban cli installed on your operating system.

> This application is compatible with latest soroban v0.23.0, please make sure you have installed this version or newer of soroban!
- To install soroban, follow the instructions in link below:
- [Install Soroban](https://soroban.stellar.org/docs/getting-started/setup)

- To verify that soroban properly installed, run:
```soroban --version```

Now that you have soroban installed, you can install the SOROBAN CLI GUI application by following the instructions below.

###  macOS (Apple Silicon | Intel)

1. Download the latest release for macOS
1. [Apple Silicon]()
2. [Intel]()
2. Open the downloaded file and drag the application to Applications folder.

### 🐧 Linux

1. Download the latest release for Linux
1. [App Image]()
2. [Snap]()

2. Follow the general instructions to install the application on your Linux distribution.
1. [App Image](https://docs.appimage.org/introduction/quickstart.html#ref-quickstart)
2. [Snap](https://snapcraft.io/docs/installing-snapd)

### 💻 Windows (Not Fully Supported)

You can still use the SOROBAN CLI GUI application on Windows by following the instructions below.

1. Install WSL 2 by following the instructions [on microsoft docs](https://learn.microsoft.com/en-us/windows/wsl/install).
2. Once you have WSL installed, you can install soroban cli by following the instructions for Linux.
3. Follow the instructions for Linux to install the SOROBAN CLI GUI application.
---

## Key Features

**Project Management:** This feature allows users to efficiently manage their projects. It includes capabilities to create new projects, add existing ones from your device, and delete projects that are no longer needed.

**Identity Management:** This component focuses on managing user identities. Users can generate new identities, add existing ones, delete unnecessary identities, and seamlessly switch between different identities.

**Contract Interactions:** This feature is centered around interactions with contracts (project based). Users can interact with them using a variety of contract commands, arguments, and flags through a user-friendly interface.

**Network Management:** Network management is facilitated through the ability to add and remove networks. Users can also display the list of networks.

> **P.S:** Review the [latest release notes](https://github.com/tolgayayci/soroban-cli-gui/releases/tag/v0.1.0) for more information about the features and capabilities of the SOROBAN CLI GUI application.
## Contributing

Contributions are welcomed! If you have feature requests, bug notifications or want to contribute some code, please follow the instructions below.
- **Feature Requests:** Use the [feature requests issue](https://github.com/tolgayayci/soroban-cli-gui/issues/new?assignees=tolgayayci&labels=enhancement&projects=&template=feature_request.md&title=%5BFEAT%5D) template.
- **Bug Reports:** Use the [bug reports issue](https://github.com/tolgayayci/soroban-cli-gui/issues/new?assignees=tolgayayci&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D) template.
- **Code Contributions**
- Fork this repository
- Create a new branch
- Make your changes
- Commit your changes
- Push to the branch that you opened
- Create a new pull request with some details about your changes

## License

SOROBAN CLI GUI is released under the **MIT**. See ([LICENSE](https://github.com/tolgayayci/soroban-cli-gui/blob/main/LICENSE)) for more details.
17 changes: 17 additions & 0 deletions components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "default",
"rsc": false,
"tsx": true,
"tailwind": {
"config": "renderer/tailwind.config.js",
"css": "renderer/styles/globals.css",
"baseColor": "slate",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "renderer/components",
"utils": "lib/utils"
}
}
12 changes: 12 additions & 0 deletions electron-builder.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
appId: com.example.nextron
productName: soroban-cli-gui
copyright: Copyright © 2024 Tolga Yaycı
directories:
output: dist
buildResources: resources
files:
- from: .
filter:
- package.json
- app
publish: null
Loading

0 comments on commit 414bc75

Please sign in to comment.