Skip to content

README.md

Latest commit

 

History

History
177 lines (129 loc) · 5.36 KB

README.md

File metadata and controls

177 lines (129 loc) · 5.36 KB

🔐 ENV Storage Manager

A secure, offline-first desktop application for managing environment variables across multiple projects. Built with Electron, React, and modern web technologies.

License Node Electron React

✨ Features

  • 🔒 Secure Encryption - AES-256-GCM encryption for all environment variables
  • 🖥️ Desktop Application - Native cross-platform desktop app (Windows, macOS, Linux)
  • 📁 Project Management - Organize variables by projects
  • 📤 Import/Export - Support for .env and JSON formats
  • 🔄 Copy Between Projects - Easily duplicate configurations across environments
  • 📝 Audit Logging - Track all changes to your environment variables
  • 🌙 Dark Theme - Beautiful dark-themed UI
  • 🔐 Master Password - Single password to access all your secrets
  • 💾 Offline First - All data stored locally, no cloud required

🚀 Quick Start

Prerequisites

  • Node.js 20 or higher
  • npm (comes with Node.js)

Installation

# Clone the repository
git clone https://github.com/curiouscoder-cmd/ENV_Storage.git
cd ENV_Storage

# Install dependencies
npm install

# Generate Prisma client
npx prisma generate

# Run in development mode
npm run electron:dev

Building

# Build for your platform
npm run electron:build

# The built application will be in the dist folder

📖 Usage

First Time Setup

  1. Launch the application
  2. Create a master password (remember this - it cannot be recovered!)
  3. Start creating projects and adding environment variables

Managing Projects

  • Click "New Project" to create a project
  • Select a project from the sidebar to view its variables
  • Delete projects by clicking the delete icon

Managing Environment Variables

  • Click "Add Variable" to create a new environment variable
  • Toggle visibility to show/hide values
  • Copy values to clipboard with one click
  • Edit or delete variables as needed

Import/Export

Export:

  • Click "Export .env" or "Export JSON" to download your variables
  • Choose the format that suits your needs

Import:

  • Click "Import" button
  • Upload a .env or JSON file, or paste content directly
  • Choose to skip or overwrite existing variables
  • Comments in .env files are preserved as descriptions

Copy Between Projects

  • Select variables using checkboxes
  • Click "Copy to Project (N)" button
  • Choose target project
  • Toggle overwrite mode if needed
  • Review and confirm

🛠️ Technology Stack

Backend

  • Electron 38 - Desktop application framework
  • Node.js 20+ - Runtime environment
  • Prisma ORM - Database management
  • SQLite - Local database
  • Node.js Crypto - AES-256-GCM encryption

Frontend

  • React 19 - UI framework
  • Vite 7 - Build tool and dev server
  • Ant Design 5 - UI component library
  • Tailwind CSS 4 - Utility-first CSS
  • shadcn/ui - Additional UI components
  • Lucide React - Icon library

🔒 Security

  • All environment variables are encrypted using AES-256-GCM
  • Master password is hashed using PBKDF2 with 100,000 iterations
  • Data is stored locally in an SQLite database
  • No data is sent to any external servers
  • Encryption keys are derived from your master password

📁 Project Structure

ENV_Storage/
├── electron/           # Electron main process
│   ├── main.js        # Application entry point
│   ├── preload.js     # IPC bridge
│   ├── ipc-handlers.js # Backend handlers
│   ├── crypto.js      # Encryption utilities
│   └── database.js    # Prisma client
├── src/               # React frontend
│   ├── components/    # React components
│   ├── lib/          # Utility functions
│   └── assets/       # Static assets
├── prisma/           # Database schema
│   └── schema.prisma # Prisma schema
└── public/           # Public assets

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

Development Setup

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run linting (npm run lint)
  5. Commit your changes (git commit -m 'feat: add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

📝 License

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

🙏 Acknowledgments

📧 Support

🎃 Hacktoberfest

This project participates in Hacktoberfest! Check out the official Hacktoberfest site for contribution ideas and guidelines.

Made with ❤️ by the ENV Storage Manager team