# Getting Starter

## Requirement

You need a [git](pages/requirement/git.md), `python`, [pip](pages/requirement/pip.md), and [venv](pages/requirement/venv.md) before using CostaPy.

Install them using the following commands on your `Debian` or `Ubuntu` system.

```bash
sudo apt update
sudo apt install git python3 python3-venv python3-pip
```

or you can use the following command to install similar packages using `brew`, the package manager for `macOS`:

```bash
brew install git python3
```
Installs Python 3 with `brew`, which includes `python3`, [pip3](pages/requirement/pip.md), and the [venv](pages/requirement/venv.md) module. If you don't have Homebrew installed on your `macOS`, you can install it first.

or go to the [git downloads page](https://git-scm.com/downloads) and a [Python downloads page](https://www.python.org/downloads/) and download the latest version of [Git](pages/requirement/git.md) and Python for `Windows`.

## Installation

Download from [git](pages/requirement/git.md) repository
```bash
git clone https://gitea.ditaajipratama.net/aji/costapy.git
```

Go to the directory and [pip](pages/requirement/pip.md) install with this command:

```bash
cd costapy
python3 -m venv .venv
.venv/bin/pip3 install --upgrade pip
.venv/bin/pip3 install -r requirements.txt
```

## Usage

Use this command below to start the web service and it will run on port `11000` by default
```bash
.venv/bin/python3 costa.py costapy-welcome
```
Here, `costapy-welcome` is the label of your service. You can replace it with any name you prefer.

---

[`Back to Homepage`](/) [`Learn the structure`](pages/structure)