Skip to content

secondpathstudio/privatescribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

166 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PrivateScribe.ai

An open-source private AI scribe platform. Currently support for running locally on Mac, PC, or Linux using Flask for the backend, SQLite for the database, Vite for the frontend, and Ollama for local AI inference.


Tech Stack

  • Backend: Flask, SQLAlchemy, SQLite
  • Frontend: Vite
  • AI Model Inference: Ollama (defaulting to the Llama 3.2 model)

Prerequisites

Make sure you have the following installed on your machine:

  • Python 3.8+
  • Node.js 16+
  • npm
  • Ollama (installed and running locally)

Installation

Clone the Repository

git clone https://github.com/yourusername/private-ai-scribe.git
cd private-ai-scribe

Backend Setup

Create a virtual environment and install Python dependencies:

python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
pip install -r requirements.txt

Initialize the SQLite database:

flask db upgrade  # if using migrations, otherwise your custom init command

Frontend Setup

Navigate to the frontend directory and install dependencies:

cd frontend
npm install

Running the Application

Start Backend (Flask)

From the project root:

source venv/bin/activate
flask run

Your backend will start at http://127.0.0.1:5000

Create Admin User

With the flask server running, run the following command to create an admin user:

flask create-admin

and you will be prompted to enter an email and password for the admin account. Once created, you can login.

Start Frontend (Vite)

From the frontend directory:

npm run dev

The frontend will be available at http://127.0.0.1:3000


Ollama Setup

Ensure Ollama is installed and running:

ollama serve

Download the default Llama 3.2 model:

ollama pull llama:3.2

You can test the model locally with:

ollama run llama:3.2

Make sure to configure your Flask backend to connect to the local Ollama API.


Contributing

Contributions are welcome! Please open an issue or submit a pull request.


License

This project is licensed under the MIT License - see the LICENSE file for details.

About

100% private AI transcription with an intuitive template system for maximum flexibility

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors