Vault

Vault is a simple, self-hosted, and open-source encrypted data vault. It allows users to securely store and manage their sensitive data with ease.

Table of Contents

• Vault
  • Table of Contents
  • Features
  • Tech Stack
  • Getting Started
    • Prerequisites
    • Installation
    • Running the Development Server
    • Building for Production
    • Database Migrations
    • Linting and Formatting
  • Contributing
  • License
  • Acknowledgements

Features

• Encryption: All data is encrypted to ensure security.
• Self-Hosted: Run Vault on your own server.
• Open Source: Contributions and collaborations are welcome.

Tech Stack

• Framework: Next.js
• Package Manager: pnpm
• UI: shadcn/ui (using Radix), Tailwind CSS
• Database: Turso (libSQL / SQLite)
• Database ORM: Drizzle ORM
• Authentication: Custom-built authentication
• Hashing and Encryption: bcrypt, crypto
• Linting: ESLint, Prettier
• Deployment: Vercel

Getting Started

Prerequisites

Ensure you have the following installed on your machine:

• Node.js (v18 or higher)
• pnpm

Installation

1. Clone the repository:

   git clone https://github.com/datejer/vault.git
   cd vault

2. Install dependencies:

   pnpm install

3. Configure your environment variables. Create a .env file and add the necessary variables (see .env.example for reference).

Running the Development Server

To start the development server, run:

pnpm dev

Open http://localhost:3000 with your browser to see the result.

Building for Production

To build the project for production, run:

pnpm build

Then, to start the production server, run:

pnpm start

Database Migrations

To generate and run database migrations, use the following commands:

pnpm db:generate
pnpm db:migrate

Linting and Formatting

To run the linter:

pnpm lint

To fix linting issues:

pnpm lint:fix

To format the code with Prettier:

pnpm prettier

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes. Ensure your code follows the established linting and formatting guidelines. Contributions are subject to the Code of Conduct.

License

This project is open-source and available under the MIT License.

Acknowledgements

• Next.js
• shadcn/ui
• Drizzle ORM
• Turso (libSQL / SQLite)