oVault

An open source account and password manager

Features

• Simple Authentication - Straightforward user registration and login system
• Powered by OstrichDB - Leverages OstrichDB's server, engine, and API layer for data storage
• Full Account Management - Create, modify, and delete account entries with ease
• 100% Local - Runs entirely on your machine with no internet connection required
• Zero Bloat - No unnecessary dependencies beyond the core tech stack

Tech Stack

• SvelteKit
• TypeScript
• TailwindCSS
• OstrichDB Written in Odin

Getting Started

Prerequisites

Before trying to run oVault, ensure you have:

• Odin compiler installed (For the backend)
• Node.js
• npm or yarn
• Python3

Installation

1. Clone the repository

   git clone https://github.com/SchoolyB/oVault.git
   cd oVault

2. Set up the backend

   cd OstrichDB/bin

   Create a .env file in the OstrichDB/bin directory

   touch .env

   Add the following to your new OstrichDB/bin/.env file (Do NOT change anything...Even the master secret)

    OSTRICH_ENV=development
    OSTRICH_SERVER_PORT=8042
    OSTRICH_MASTER_SECRET=your-very-strong-server-secret-here-minimum-32-chars
   

3. Build and run the backend

   cd ..
   ./scripts/local_build.sh

   The backend will start on http://localhost:8042

4. From the projects root directory generate a JWT token

   python3 generate_jwt.py

   Copy the token value that is output

5. Set up the client in second terminal

   cd client
   npm install
   # or
   yarn

6. Create .env file in the root of the client directory

   # In the client directory, create a .env file with:
   PUBLIC_OSTRICHDB_TOKEN=your_token_from_step_4

7. Run the client

   npm run dev
   # or
   yarn dev

   The client will be available at http://localhost:5173

Documentation

If you are interested in learning more about my from-scratch database, OstrichDB and its slowly growing ecosystem you can find that all here :

OstrichDB.com Open-OstrichDB: The from-scrath open source backend OstrichDB Docs OstrichDB-JS SDK OstrichDB-CLI

Contribution is more than welcome on any of theres projects including oVault!