Development Setup

Manual Installation

You can manually set up the development environment using the following steps:

Prerequisites

You need to have the following installed on your system:

  • Python 3.6 or higher
  • Git

Setting up the environment manually

Follow the steps below to set up the development environment:

  • 1
    Clone the repository:
    git clone https://github.com/srajan-kiyotaka/TraverseCraft.git
  • 2
    Change the directory to the cloned repository:
    cd TraverseCraft
  • 3
    Create a virtual environment:

    For more information, check out venv — Creation of virtual environments

    python -m venv venv
  • 4
    Activate the virtual environment:
    # For Windows
    source venv/bin/activate
    # For Linux
    venv\Scripts\activate
  • 5
    Install the dependencies:
    pip install prettytable

The application is now set up!

Setting up the environment using Docker

You can set up the development environment using Docker as well!

To set up a development environment using Docker, follow these steps:

  • 1
    Clone the repository:
    git clone https://github.com/srajan-kiyotaka/TraverseCraft.git
  • 2
    Change the directory to the cloned repository:
    cd traverse-craft
  • 3
    Build the Docker image:
    docker build -t traverse-craft:latest .
  • 4
    Run the Docker container:
    docker run -it --rm traverse-craft:latest