Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apptools-lab/AppToolkit
🐘 The Front-end Env Toolkit（前端环境管理工具）
https://github.com/apptools-lab/AppToolkit
electron electron-app environment git ssh
Last synced: 3 months ago
JSON representation
🐘 The Front-end Env Toolkit（前端环境管理工具）
- Host: GitHub
- URL: https://github.com/apptools-lab/AppToolkit
- Owner: apptools-lab
- Created: 2021-04-12T10:09:41.000Z (over 3 years ago)
- Default Branch: feat/cli
- Last Pushed: 2024-05-23T07:33:16.000Z (6 months ago)
- Last Synced: 2024-05-23T08:40:52.318Z (6 months ago)
- Topics: electron, electron-app, environment, git, ssh
- Language: TypeScript
- Homepage:
- Size: 5.2 MB
- Stars: 558
- Watchers: 10
- Forks: 72
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-github-star - AppToolkit - end Env Toolkit（前端环境管理工具） | apptools-lab | 521 | (TypeScript)
README
# Toolkit
Toolkit is a CLI that helps you to initialize your development environment faster.
## Features
🌎 Cross-platform support (macOS, Windows. Linux is coming soon)
✨ Support custom your toolkits and install them with one command
📦 Share your toolkits manifest with your team members
🚀 Built with rust and install toolkits in parallel
## Quick Start
**Windows Users NOTE: Currently, you may need to follow the installation instructions to install toolkits manually.**
### Using a script (For MacOS and Linux)
```shell
curl -fsSL https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/shell/install.sh | bash -s -- --install
```
#### Parameters
`--install`
Install the recommended toolkits (for web development)
`--manifest`
Install your toolkits by specifying the manifest file path. For example:
```shell
# install the recommended toolkits (for web development)
curl -fsSL https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/shell/install.sh | bash -s -- --install
# install your toolkits by specifying the manifest file path
curl -fsSL https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/shell/install.sh | bash -s -- --install --manifest https://the-remote-server/your-toolkits-manifest-path
```
### Using a release binary
1. Download the [latest release](https://github.com/apptools-lab/AppToolkit/releases) binary for your system
2. Unzip the downloaded file
3. Run the following commands in your terminal
**Macos and Linux**
```shell
$ chmod +x toolkit
# install the default toolkits (for web development)
$ ./toolkit install
# install your toolkits by specifying the manifest file path
$ ./toolkit install --manifest
```
**Windows**
```shell
# install the default toolkits (for web development)
$ .\toolkit.exe install
# install your toolkits by specifying the manifest file path
$ .\toolkit.exe install --manifest
```
## Customization
You can customize your toolkits which to be installed in a json file. Here is a [json schema](./toolkits.schema.json) for you to follow and you can get the hint in the popular IDEs like Visual Studio Code, IntelliJ and so on. For Example:
```json
{
"$schema": "https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/toolkits.schema.json",
"description": "",
"author": "",
"version": "",
"toolkits": [
{
"name": "Visual Studio Code",
"description": "",
"installations": [
{
...
}
]
}
]
}
```
Now AppToolkit supports the following types of tool:
- Windows
- [x] exe
- MacOS
- [x] dmg
- [x] zip
- [x] shell
- Linux
- [ ] deb
- [ ] rpm
- [ ] shell
If you want to support more types of toolkits, you can submit a PR or issue to us.
You can see [tookits.manifest.json](./toolkits.manifest.json) for reference.
After completion, you can save your toolkit schema in a json file locally or upload it to the remote server(GitHub repo or cloud storage). You can share your toolkit manifest with your team members or friends.
Then you can install your custom toolkits with the following command:
```shell
# windows
$ .\toolkit.exe install --manifest https://the-remote-server/your-toolkits-manifest-path
# macos
$ ./toolkit install --manifest https://the-remote-server/your-toolkits-manifest-path
```
## Contribution
Toolkit is still in the early stage of development, and we are working hard to improve it. If you have any suggestions or ideas, please feel free to submit an issue or PR.