Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[170] Documentation - Intro and Installation #202

Merged
merged 2 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 0 additions & 38 deletions documentation/docs/install-tirith-on-linux.md

This file was deleted.

38 changes: 0 additions & 38 deletions documentation/docs/install-tirith-on-mac.md

This file was deleted.

38 changes: 0 additions & 38 deletions documentation/docs/install-tirith-on-windows.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
id: developer-mode-installation
title: Installation for Developers (Using Docker and Dev Containers in VS Code)
sidebar_label: Developer Mode Setup
description: This documentation overviews you about the introduction of the Tirith software installation on your respective operating system.
keywords:
- Tirith
- StackGuardian
# url: https://www.tirith.com/support/docs/getting-started-with-tirith
site_name: Tirith
slug: developer-mode-installation/
---

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Home",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "Installation",
"item": "https://www.lambdatest.com/support/docs/developer-mode-installation/"
refeed marked this conversation as resolved.
Show resolved Hide resolved
}]
})
}}></script>
For developers who want to contribute to Tirith, setting up a [Dev Container in Visual Studio Code (VS Code)](https://code.visualstudio.com/docs/devcontainers/create-dev-container#_create-a-devcontainerjson-file) offers a robust development environment. This approach ensures that all dependencies and configurations are consistent across different setups.

## Prerequisite
- Make sure your machine has [Python](https://www.python.org/downloads/) and [pip](https://pip.pypa.io/en/stable/installation/) installed.
- Install [Git](https://git-scm.com/downloads) on your machine.
- Basic knowledge on [Docker](https://docs.docker.com/engine/install/) is required.

## Steps to Install Tirith

### Step 1: Clone the Repository
Clone the Tirith repository from GitHub to get the latest code:

```bash
git clone https://github.com/StackGuardian/tirith.git
cd tirith
```

### Step 2: Set Up Docker
Ensure [Docker](https://docs.docker.com/engine/install/) is installed and running on your machine. You can manage Docker using Docker Desktop or the command-line interface (CLI). Docker allows you to run Tirith within isolated containers, preventing any dependency conflicts with your local system.

### Step 3: Open the Project in VS Code
- Launch Visual Studio Code and open the cloned repository folder.
- Open the Command Palette by pressing `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS).
- Search for **Dev Containers: Rebuild and Reopen in Container** and select this option.
- VS Code will use the `devcontainer.json` configuration file within the project to build a containerized environment for Tirith. This configuration file contains settings for the development environment, such as necessary extensions and dependencies. Building the container may take a few minutes.
- Once the container is running, you’ll have a fully configured development environment within Docker, optimized for Tirith development.
85 changes: 85 additions & 0 deletions documentation/docs/tirith-installation/manual-installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
id: manual-installation
title: Manual Installation (Using a Python Virtual Environment)
sidebar_label: Manual Setup
description: This documentation overviews you about the introduction of the Tirith software installation on your respective operating system.
keywords:
- Tirith
- StackGuardian
# url: https://www.tirith.com/support/docs/getting-started-with-tirith
site_name: Tirith
slug: manual-installation/
---

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Home",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "Installation",
"item": "https://www.lambdatest.com/support/docs/manual-installation/"
}]
})
}}></script>
If you prefer a manual setup, especially if you want to modify Tirith’s codebase directly, follow these steps to install Tirith in a virtual Python environment.

## Prerequisite
- Make sure your machine has [Python](https://www.python.org/downloads/) and [pip](https://pip.pypa.io/en/stable/installation/) installed.
- Install [Git](https://git-scm.com/downloads) on your machine.

## Steps to Install Tirith

### Step 1: Clone the Repository
Clone the Tirith repository from GitHub to get the latest code:

```bash
git clone https://github.com/StackGuardian/tirith.git
cd tirith
```

### Step 2: Set Up a Python Virtual Environment
Setting up a virtual environment isolates Tirith’s dependencies, preventing potential conflicts with other projects on your machine.

Create a Virtual Environment:

```bash
virtualenv .venv
```

Activate the Virtual Environment:

```bash
source .venv/bin/activate
```

This command activates the virtual environment, ensuring all packages you install are contained within this environment.

### Step 3: Install Tirith
With the virtual environment activated, install Tirith:

```bash
pip install -e .
```
The -e flag installs Tirith in `editable` mode, allowing you to make modifications to the codebase without needing to reinstall the package.

### Step 4: Verify Installation
To confirm Tirith is installed and running properly, check its version:

```bash
tirith --version
```
You should see a version number output, verifying that Tirith is set up correctly.
<br />
<img loading="lazy" src={require('../../assets/installation/tirith-version.png').default} alt="tirith-version" className="doc_img"/>
58 changes: 58 additions & 0 deletions documentation/docs/tirith-installation/quick-intallation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
id: quick-installation
title: Quick Installation for Users
sidebar_label: Quick Setup
description: This documentation overviews you about the introduction of the Tirith software installation on your respective operating system.
keywords:
- Tirith
- StackGuardian
# url: https://www.tirith.com/support/docs/getting-started-with-tirith
site_name: Tirith
slug: quick-installation/
---

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Home",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "Installation",
"item": "https://www.lambdatest.com/support/docs/quick-installation/"
}]
})
}}></script>
If you simply want to install and start using Tirith, this option provides a fast installation process with minimal setup. Perfect for end users and non-developers who only need basic functionality.

## Prerequisite
- Make sure your machine has [Python](https://www.python.org/downloads/) and [pip](https://pip.pypa.io/en/stable/installation/) installed.
- Install [Git](https://git-scm.com/downloads) on your machine.

## Steps to Install Tirith

### Step 1: Install using the `pip` command
Run the following command in your terminal to download Tirith directly from the GitHub repository and install it on your local system. This command ensures that you have the latest version.

```bash
pip install git+https://github.com/StackGuardian/tirith.git
```


### Step 2: Verify Installation
Once installed, verify that Tirith is working by checking its version. You should see a version number (e.g., 1.0.0-beta.12) indicating successful installation.
```bash
tirith --version
```
<br />
<img loading="lazy" src={require('../../assets/installation/tirith-version.png').default} alt="tirith-version" className="doc_img"/>
19 changes: 10 additions & 9 deletions documentation/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@ module.exports = {
{
type: "category",
collapsed: true,
label: "Installation",
label: "Setup Tirith",

items: [
"install-tirith-on-linux",
"install-tirith-on-windows",
"install-tirith-on-mac"
'tirith-installation/quick-installation',
'tirith-installation/developer-mode-installation',
'tirith-installation/manual-installation'
]
},
{
type: "category",
collapsed: true,
label: "Tirith Policies",
items: [
"tirith-policy-structure",
"tirith-policy-error-tolerance",
"tirith-policy-conditions",
"tirith-policy-variables",
"tirith-policy-examples"
"tirith-policies/tirith-policy-structure",
"tirith-policies/tirith-policy-error-tolerance",
"tirith-policies/tirith-policy-conditions",
"tirith-policies/tirith-policy-variables",
"tirith-policies/tirith-policy-examples"
]
},
],
Expand Down
Loading