Skip to content

utkarsh0493/FSS-Nav-App

Repository files navigation

FSS Navigator App

Python Streamlit License

A local Streamlit application for navigating standardized computational project structures.

Purpose

FSS Navigator App helps users inspect computational research projects directly on their own local machine. It scans a selected project folder and previews supported files in an interactive explorer-style interface.

No project files are uploaded to an external server.

This project is a modernized and fully interactive Streamlit-based evolution of the original FSS Navigator available at: FSS-Nvaigator

Unlike the original implementation, this version is built entirely using Streamlit functionality and focuses on local-first interactive navigation, visualization, and lightweight inspection of computational project structures.

Portfolio relevance

This project demonstrates how a command-line/script-based research utility can be transformed into a production-style local interactive data application.

It showcases:

  • Python application development
  • Streamlit-based data app design
  • Local file-system parsing
  • Interactive project navigation
  • Modular software architecture
  • Automated testing with pytest
  • Continuous integration with GitHub Actions
  • Cross-platform executable packaging
  • Privacy-aware scientific tooling

Main features

  • Local project-folder navigation
  • Tree-style directory browser
  • Interactive preview panel
  • Search across selected directory
  • Selectable project path input
  • Preview support for:
    • Text and code files
    • Markdown
    • CSV/TSV
    • Images
    • PDFs
    • Jupyter notebooks
    • DOCX
    • PPTX
  • Hyperlink-aware previews for DOCX, PPTX, and PDF files
  • Privacy-first local execution
  • No upload of project files

Project structure

FSS-Navigator-App/
├── .github/
│   └── workflows/
├── CodeDocumentations/
├── Computations/
│   ├── Code/
│   │   ├── app/
│   │   ├── core/
│   │   └── tests/
│   └── Results/
├── Data/
├── environment.yml
├── environment-ci.yml
├── requirements.txt
├── run_app.py
└── README.md

Download executable

Pre-built executables are available from the GitHub Releases page.

Download the version for your operating system:

  • macOS
  • Windows
  • Linux

After unzipping, run the executable from the folder you want to inspect.

Run locally

Clone the repository:

git clone https://github.com/utkarsh0493/FSS-Nav-App.git

Create the Conda environment:

conda env create -f environment.yml
conda activate fssnav

Run the application:

python run_app.py

The app opens locally in your web browser.

Latest release

v0.2.0

  • Added selectable project path input
  • Added search across selected directory
  • Added hyperlink-aware DOCX/PPTX/PDF previews
  • Improved Markdown rendering and wrapping
  • Improved tree-style explorer UI
  • Added cross-platform executable builds

License

This project is distributed under the MIT License.

About

Privacy-first local Streamlit app for navigating computational research projects.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages