Skip to content

Latest commit

 

History

History
118 lines (84 loc) · 2.88 KB

README.md

File metadata and controls

118 lines (84 loc) · 2.88 KB

Development Environment Setup

This guide will help you set up the development environment.

🐳 Docker Setup

Please follow the instruction is this section to setup your development environment using Docker.

Prerequisites

  • Docker installed on your system
  • Git installed on your system

Setup Instructions

  1. Clone the repository:
git clone https://github.com/comrade-coop/teesa-aapp.git
  1. Navigate to the repository root directory:
cd teesa-aapp
  1. Build the Docker container:
docker build --pull --rm -f "dev-setup/Dockerfile" -t teesa-aapp:latest .
  1. Start the container:
chmod +x dev-setup/start.sh
./dev-setup/start.sh clear

The dev-setup/start.sh script accepts the following parameters:

  • Use ./dev-setup/start.sh clear to clean the SSH hosts entry. This should only be used after rebuilding the container.
  • Use ./dev-setup/start.sh without parameters for regular container startup.
  1. Connect to the container:
ssh root@localhost -p 22909

Connection details:

  • Host: localhost
  • Port: 22909
  • Username: root
  • Password: p

Note: We have configured the container with persistent volumes for VSCode and Cursor extensions and settings, so you have a consistent development environment across container restarts.

Note: We have configured the container with Docker socket volume, so you can access the Docker daemon on the host machine from the container.

Note: We have configured the container with persistent volume for Ollama, so we keep the pulled models when restarting the container.

This will set up your development environment in a Docker container with all the necessary dependencies installed.

🛠️ Local Setup

Please follow the instruction in this section to setup your development environment without using Docker.

Prerequisites

Make sure you have the following installed:

Environment Setup

  1. Install NVM

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

  2. Install direnv (optional if want to use .envrc to automatically set the correct node version when navigating to the repository directory)

    • For MacOS
    brew install direnv
    • For Linux/WSL2 on Windows
    sudo apt-get install direnv

  3. Clone the repository

    git clone https://github.com/comrade-coop/teesa-aapp.git

  4. Navigate to the repository root directory

    cd teesa-aapp

  5. Install Node based on the .nvmrc file

    nvm install

  6. Install Pnpm

    npm install -g pnpm

  7. Allow direnv (if you installed direnv in 4.)

    direnv allow