Skip to content

SETUP.md

Latest commit

 

History

History
129 lines (83 loc) · 2.53 KB

SETUP.md

File metadata and controls

129 lines (83 loc) · 2.53 KB

How to run Jarvis locally

Welcome to the Jarvis Virtual Assistant! This guide will walk you through setting up the project on your local machine so you can explore features, understand the internal flow, and start contributing.

📋 Prerequisites

Ensure you have the following installed:

Optional but recommended:

  • A virtual environment tool like venv or virtualenv

📦 Clone the Repository

git clone https://github.com/Code-A2Z/jarvis.git
cd jarvis

🧰 Install uv

▶️ Windows

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

🐧 macOS/Linux

curl -LsSf https://astral.sh/uv/install.sh | sh

🧪 Install Dependencies

uv sync

🔐 Configure .streamlit/secrets.toml

If the .streamlit folder doesn't exist, create it:

mkdir .streamlit

Then create a file named secrets.toml inside .streamlit and add the following fields only (as per maintainer's request):

[general]
ADMIN_EMAIL = ""
ADMIN_NAME = ""

[auth]
redirect_uri = ""
cookie_secret = ""

[auth.google]
client_id = ""
client_secret = ""
server_metadata_url = ""

🔒 Keep this file private. Never commit secrets to the repository.

🧪 Mock Authentication (Optional)

To test features without logging in via Google, you can mock a user manually.

In home.py, add:

st.session_state.user = {
    "name": "Test User",
    "email": "test@example.com"
}

This will let you access all core features locally during development.

🚀 Run Jarvis

Launch the application:

uv run streamlit run src/apps/public/home.py

It should open in your browser at http://localhost:8501.

🛠️ Common Errors & Fixes

  • ModuleNotFoundError: Make sure the virtual environment is activated and dependencies installed.
  • secrets.toml not found: Ensure .streamlit/secrets.toml exists and is correctly formatted.
  • Google login not working: Re-check your client_id, client_secret, and redirect_uri.

🤝 Want to Contribute?

Happy coding! 💻✨ Let Jarvis assist you.