Skip to content

README_SPINUP.md

Latest commit

 

History

History
89 lines (65 loc) · 2.13 KB

README_SPINUP.md

File metadata and controls

89 lines (65 loc) · 2.13 KB
Raw

TectoniQ Spin-Up Procedure

This document provides step-by-step instructions on how to spin up the TectoniQ backend services and frontend application locally, along with the corresponding localhost URLs.

Spin-Up Procedure

Prerequisites

  • Python 3.10+
  • Node.js (for npx tool support)

Step 1: Spin Up the Backend

  1. Navigate to the backend directory:

    cd backend

  2. Set up a Python Virtual Environment:

    python3 -m venv .venv
source .venv/bin/activate

  3. Install Dependencies:

    pip install -r requirements.txt

  4. Configure Environment Variables: Create a .env file in the backend/ directory:

    cp .env.example .env

    Open the .env file and enter your Gemini API key and port:

    GEMINI_API_KEY=your_gemini_api_key_here
FLASK_PORT=5050

    Note: If no Gemini API key is provided, the application will degrade gracefully and skip the AI-labelling step, while the rest of the parsing pipeline will run normally.

  5. Start the Flask Backend Server:

    python app.py

    The backend starts running at:

    • Local Host URL: http://localhost:5050

Step 2: Spin Up the Frontend

Once the backend server is running and healthy, spin up the frontend server.

  1. Navigate to the project root directory:

    cd ..

  2. Start the static file server: Use npx to serve the static frontend assets on port 3050:

    npx -y serve -l 3050 .

    The frontend starts running at:

    • Local Host URL: http://localhost:3050

Alternative: Run Both Simultaneously

You can also spin up both servers in a single terminal window using the included startup shell script:

chmod +x start.sh
./start.sh

Local Host Links

Once both steps are complete, you can access the services at: