28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# Stack-Up dev-env
|
|
## Introduction
|
|
This project is the development environment of all stack-up projects.
|
|
It simplifies handling different docker-enabled applications and their maintenance.
|
|
|
|
## Installation
|
|
- Create a .systems file bases on .systems.example: `cp .systems.example .systems`
|
|
- Enter all systems in the created file `nano .systems`
|
|
- run `./init`. Init will:
|
|
- update `.aliases` file, which enables you to switch between your systems easily via `goto-<system-identifier>`
|
|
- updates `.profile` to use the updated aliases, enables the dev-env binaries (denv, drun, dcom, ...) and add some utility functions
|
|
- clones all systems defined in `.systems`
|
|
- calls the `bin/script/init` script for all cloned systems.
|
|
- Perform init actions on systems
|
|
- `./up` to start your containers
|
|
- up will also run all the `bin/script/firstRun` scripts, if the `.firstRun` marker is missing
|
|
|
|
## Usage
|
|
After the installation was performed successfully and you've sourced your ~/.profile file, you'll have access to the following utilities:
|
|
- denv
|
|
- without a parameter, navigates to the development environment
|
|
- if a parameter is specified, denv will try to execute the passed script in the dev-env base folder
|
|
- drun
|
|
- executes a command on the app container of a system
|
|
- dcom
|
|
- executes a docker compose command.
|
|
- without a parameter, for the system of the current directory
|
|
- with a parameter, for the supplied system-id |