osintbuddy/backend

OSINTBuddy Backend

About the Project

The core of the backend is a FastAPI app running on Python 3.11.4.You can find the backend dockerfile here and the selenium provider here among a few other things.

Dependencies

General purpose:

• fastapi
• fastapi-cache
• SQLAlchemy
• tenacity
• gremlinpy
• colorama
• pyfiglet
• termcolor

For creating and saving WARC files we're planning to use (todo):

• selenium-wire
• warc
• celery
• minio

For telemetry we're planning to add (todo):

• opentelemetry.io

Testing, Linting, Formatting, and Githooks (todo):

• pytest
• pylama[all]
• brunette
• .githooks

Getting Started

1. Clone the repo

   git clone --recurse-submodules https://github.com/jerlendds/osintbuddy.git
   # using ssh?
   # git clone --depth=1 --recurse-submodules git@github.com:jerlendds/osintbuddy.git 
   cd osintbuddy
   

2. Setup your dev env/venv and install development dependencies. From the osintbuddy directory run:

   ./launcher bootstrap 
   

3. Start the stack

   ./launcher start
   # restart the backend:     ./launcher restart backend
   # stop the backend:        ./launcher stop backend
   # kill the stack:          ./launcher kill
   # generate UI api client:   npm run client:gen (only works if the backend is running)
   

   • Frontend: http://localhost:3000
   • Backend: http://localhost:48997/
   • Casdoor: http://localhost:45910/