From 264b138f1c5420d707ee89c6cede58b241ea56c1 Mon Sep 17 00:00:00 2001 From: NguyenAnhQuan Date: Fri, 14 Nov 2025 01:34:35 +0700 Subject: [PATCH] 141125/edit_README.md --- README.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 98 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ff08476..254359f 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,118 @@ -# web-wallet +# Neptune Web Wallet -## Project Setup +A secure Electron-based desktop wallet for the Neptune blockchain network. + +## 🚀 Features + +- 🔐 Secure keystore encryption (AES-256-GCM) +- 💼 Create and recover wallets from seed phrases +- 💸 Send and receive Neptune tokens +- 📊 View transaction history and UTXOs +- 🛡️ Enhanced security with strict Content Security Policy + +## 📋 Prerequisites + +- Node.js >= 16 +- npm or yarn + +## 🔧 Installation + +Install dependencies: ```sh -yarn +npm install ``` -### Compile and Hot-Reload for Development +## 💻 Development + +### Start Electron app in development mode ```sh -yarn dev +npm run start:electron ``` -### Type-Check, Compile and Minify for Production +### Start Vite dev server only ```sh -yarn build-only +npm run dev ``` -### Lint with [ESLint](https://eslint.org/) +### Type-check ```sh -yarn lint +npm run type-check ``` -### Format code +### Lint with ESLint ```sh -yarn format +npm run lint ``` + +### Format code with Prettier + +```sh +npm run format +``` + +## 📦 Production Build + +### Package the application + +```sh +npm run package:electron +``` + +### Create distributables (installers) + +```sh +npm run make:electron +``` + +The installers will be generated in `out/make/` directory: +- **Windows**: `.exe` installer in `out/make/squirrel.windows/x64/` +- **macOS**: `.zip` in `out/make/zip/darwin/` +- **Linux**: `.deb` and `.rpm` in respective directories + +## 🔐 Security Features + +- ✅ Context isolation enabled +- ✅ Node integration disabled +- ✅ Sandbox enabled +- ✅ Strict Content Security Policy in production +- ✅ Certificate validation +- ✅ Path traversal protection +- ✅ Input validation for all IPC handlers +- ✅ Secure keystore encryption with scrypt and AES-256-GCM + +## 🌍 Environment Variables + +Create a `.env` file in the root directory: + +```env +# Neptune API URL +VITE_APP_API= + +# Network (mainnet or testnet) +VITE_NODE_NETWORK=mainnet +``` + +## 🛠️ Tech Stack + +- **Framework**: Electron + Vue 3 + TypeScript +- **Build Tool**: Vite +- **State Management**: Pinia + +## 📝 License + +Apache-2.0 + +## 👥 Authors + +Neptune Team + +## 🔗 Links + +- [Neptune Blockchain](https://neptune.cash) +- [Documentation](#) +- [Report Issues](#)