https://github.com/tungbq/localenv
🐳 LocalEnv - Local Containerized Environment supports various languages.
https://github.com/tungbq/localenv
container development docker environment golang goovy javascript local python tooling
Last synced: 7 months ago
JSON representation
🐳 LocalEnv - Local Containerized Environment supports various languages.
- Host: GitHub
- URL: https://github.com/tungbq/localenv
- Owner: tungbq
- License: apache-2.0
- Created: 2024-05-18T08:21:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T23:50:11.000Z (over 1 year ago)
- Last Synced: 2025-03-10T17:15:42.686Z (7 months ago)
- Topics: container, development, docker, environment, golang, goovy, javascript, local, python, tooling
- Language: Shell
- Homepage:
- Size: 56.6 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
🐳 LocalEnv
Local Containerized Environment supports various programming languages
## Introduction 👋
LocalEnv is a tool designed for local development, allowing you to execute code in multiple languages without installing numerous tools on your PC. With [Docker](https://www.docker.com/) as the only prerequisite, you can seamlessly run code in various environments.
## Prerequisites 🔓
Before you begin, ensure that you have [Docker](https://docs.docker.com/engine/install/) installed. It's also helpful to have a basic understanding of Docker concepts.
## Key Features 🚀
- **Quickly write and run code**: LocalEnv allows you to rapidly write and execute code in containerized environments locally.
- **[localenv](./localenv) script**: The repository includes a convenient `localenv` script that simplifies the execution of code in different languages within Docker containerized environments.
- **[env](./env/) folder**: Contains the code and document for each supported language.
- **[config.yaml](./config.yaml) file**: This config file allows users to configure their target environment settings easily. This includes specifying Docker images, default container names, and base commands for each language.
## Demo 🔥
```bash
# Clone LocalEnv repository
git clone https://github.com/tungbq/LocalEnv.git
cd LocalEnv
# Execute python code
./localenv python env/python/demo.py
# Execute javascript code
./localenv javascript env/javascript/demo.js
```
## Supported Environment 🚀
Current support languages in below table
| Language | Quick Start | User guide | Image |
| ---------- | ----------------------------------------------- | ------------------------------- | ----------------------------------------------------- |
| Python | `./localenv python env/python/demo.py` | [python](./env/python/) | [Find](https://hub.docker.com/_/python) |
| Powershell | `./localenv powershell env/powershell/demo.ps1` | [powershell](./env/powershell/) | [Find](https://hub.docker.com/_/microsoft-powershell) |
| Groovy | `./localenv groovy env/groovy/demo.groovy` | [groovy](./env/groovy/) | [Find](https://hub.docker.com/_/groovy) |
| Javascript | `./localenv javascript env/javascript/demo.js` | [javascript](./env/javascript/) | [Find](https://hub.docker.com/_/node/) |
| Golang | `./localenv golang env/golang/demo.go` | [go](./env/golang/) | [Find](https://hub.docker.com/_/golang/) |
| Java | `./localenv java env/java/demo.java` | [java](./env/java/) | [Find](https://hub.docker.com/_/openjdk) |
## Usage 📖
To use the LocalEnv tool, follow these steps:
### 1. Clone
Clone the repository:
```bash
git clone https://github.com/tungbq/LocalEnv.git
cd LocalEnv
```
### 2. Configure
Configure your environment:
- Edit the [config.yaml](config.yaml) file to specify the details of the environment you want to use, for example:
```yaml
# File: ./config.yaml
python:
image: 'python:3.12'
default_container_name: 'pyEnv'
base_command: 'python'
```
### 3. Code
Write your own code under [env](./env/), for example:
- Python: [python](./env/python/)
- Powershell: [powershell](./env/powershell/)
### 4. Run
Run a script:
- Use the following command format to run your script within the containerized environment:
```bash
./localenv
```
For example, to run a Python script:
```bash
./localenv python env/python/demo.py
```
### 5. More
Refer to the user guide for detailed instructions on using each supported environment. Links to the user guides are available in the table above.
## Troubleshooting
- For common issue, visit [troubeshooting.md](./docs/troubeshooting.md)
## Contributing
- See: [CONTRIBUTING.md](./CONTRIBUTING.md)
- If you find this repository helpful, kindly consider showing your appreciation by giving it a star ⭐ Thanks! 💖
- Feel free to open a new issue if you encounter the LocalEnv bug or want to request more content about LocalEnv
- Submit a new issue (🐛) if you encounter the bug/error when using this repo