Setting Up New Environment

Quick reference for getting Ginx working in a new environment - whether you're a new team member, setting up a new machine, or working with a fresh project.

What This Covers

"New environment" means any situation where you need to get a Ginx-enabled project running from scratch:

• 👥 New team member joining an existing project

• 💻 New machine or fresh OS installation

• 🏗️ New project clone from Git

• 🐍 New Python version or virtual environment

Quick Setup (2 Minutes)

1

Get the Project

git clone your-project-repo
cd your-project

2

Install Ginx

pip install ginx

3

Install Dependencies

ginx install-deps

4

Verify Setup

ginx version

Done! If ginx version displays ginx version on the terminal, your environment is ready

Step-by-Step Setup

Install Ginx

# Option A: Global installation
pip install ginx

# Option B: User installation (if no admin rights)
pip install --user ginx

# Option C: In virtual environment (recommended)
python -m venv .venv
source .venv/bin/activate  # Linux/Mac
# .venv\Scripts\activate   # Windows
pip install ginx

Why virtual environments? They isolate your project dependencies and prevent conflicts between projects.

Initialize Ginx

ginx init              # This will create a simple ginx.yaml

Check Project Configuration

ginx validate               # Verify ginx.yaml is valid
ginx list                   # See available scripts

If ginx validate shows errors, the project configuration needs fixing. If ginx list shows no scripts, check if you're in the right directory.

Understand Environment Status

ginx env                    # Show Python environment info
ginx deps                   # Check what's missing

Read the env info, if everything is fine then Your development environment is now ready! 🚀