Skip to content
Draft
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
638 changes: 638 additions & 0 deletions docusaurus/docs/Contributing Guide/contributing.md

Large diffs are not rendered by default.

900 changes: 900 additions & 0 deletions docusaurus/docs/Contributing Guide/style-guide.md

Large diffs are not rendered by default.

554 changes: 554 additions & 0 deletions docusaurus/docs/Data/download.md

Large diffs are not rendered by default.

556 changes: 556 additions & 0 deletions docusaurus/docs/Data/market-data-sources.md

Large diffs are not rendered by default.

856 changes: 856 additions & 0 deletions docusaurus/docs/Data/multiple-market-data-sources.md

Large diffs are not rendered by default.

25 changes: 0 additions & 25 deletions docusaurus/docs/Getting Started/application-setup/index.html

This file was deleted.

23 changes: 0 additions & 23 deletions docusaurus/docs/Getting Started/backtesting/index.html

This file was deleted.

520 changes: 520 additions & 0 deletions docusaurus/docs/Getting Started/deployment.md

Large diffs are not rendered by default.

17 changes: 0 additions & 17 deletions docusaurus/docs/Getting Started/deployment/index.html

This file was deleted.

52 changes: 52 additions & 0 deletions docusaurus/docs/Getting Started/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
sidebar_position: 1
---

# Installation

Get started with the Investing Algorithm Framework by following these simple installation steps.

## Prerequisites

Before installing the framework, ensure you have:

- **Python 3.10+** installed on your system
- **pip** (Python package installer)
- **git** (for cloning repositories)

## Installation Options

### Option 1: Install from PyPI (Recommended)

Install the latest stable version from PyPI:

```bash
pip install investing-algorithm-framework
```

### Option 2: Install from Source

For the latest development version, install directly from GitHub:

```bash
pip install git+https://github.com/coding-kitties/investing-algorithm-framework.git
```

### Option 3: Development Installation

If you plan to contribute to the framework:

1. **Clone the repository:**
```bash
git clone https://github.com/coding-kitties/investing-algorithm-framework.git
cd investing-algorithm-framework
```

2. **Install in development mode:**
```bash
pip install -e .
```

## Next Steps

Once installation is complete, proceed to [Application Setup](application-setup) to create your first trading application!
17 changes: 0 additions & 17 deletions docusaurus/docs/Getting Started/installation/index.html

This file was deleted.

Loading