Skip to content

Commit d41070b

Browse files
docs: remove all Python references and update for Node.js/Electron
- Update installation.md with Node.js instructions - Update SETUP_CHECKLIST.md with Node.js/Electron topics - Update CONTRIBUTING.md with JavaScript/React guidelines - Replace Python commands with npm commands - Update development setup instructions - Fix code examples to use JavaScript - Update resource links
1 parent b797ca2 commit d41070b

File tree

3 files changed

+143
-183
lines changed

3 files changed

+143
-183
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Before creating bug reports, please check the existing issues to avoid duplicate
3030
- **Provide specific examples**
3131
- **Describe the behavior you observed and what you expected**
3232
- **Include screenshots if relevant**
33-
- **Include your environment details** (OS, Python version, etc.)
33+
- **Include your environment details** (OS, Node.js version, etc.)
3434

3535
### Suggesting Enhancements 💡
3636

@@ -79,62 +79,51 @@ Unsure where to begin? Look for issues labeled:
7979

8080
### Prerequisites
8181

82-
- Python 3.8 or higher
83-
- pip (Python package manager)
82+
- Node.js 20 or higher
83+
- npm (Node package manager)
8484
- Git
8585

8686
### Installation
8787

88-
1. **Create a virtual environment**:
88+
1. **Install dependencies**:
8989
```bash
90-
python -m venv venv
91-
source venv/bin/activate # On Windows: venv\Scripts\activate
90+
npm install
9291
```
9392

94-
2. **Install dependencies**:
93+
2. **Generate Prisma client**:
9594
```bash
96-
pip install -r requirements.txt
97-
pip install -r requirements-dev.txt # Development dependencies
95+
npx prisma generate
9896
```
9997

100-
3. **Install pre-commit hooks**:
98+
3. **Run in development mode**:
10199
```bash
102-
pre-commit install
100+
npm run electron:dev
103101
```
104102

105103
### Running Tests
106104

107105
```bash
108-
# Run all tests
109-
pytest
106+
# Run tests (when implemented)
107+
npm test
110108

111-
# Run with coverage
112-
pytest --cov=src --cov-report=html
109+
# Run linting
110+
npm run lint
113111

114-
# Run specific test file
115-
pytest tests/test_crypto.py
116-
117-
# Run tests in watch mode
118-
pytest-watch
112+
# Build the application
113+
npm run build
119114
```
120115

121116
### Code Quality Checks
122117

123118
```bash
124-
# Run linter
125-
flake8 src/ tests/
126-
127-
# Run type checker
128-
mypy src/
129-
130-
# Format code
131-
black src/ tests/
119+
# Run ESLint
120+
npm run lint
132121

133-
# Sort imports
134-
isort src/ tests/
122+
# Build the application
123+
npm run build
135124

136125
# Run all checks (recommended before committing)
137-
pre-commit run --all-files
126+
npm run lint && npm run build
138127
```
139128

140129
## 🔄 Pull Request Process
@@ -165,8 +154,9 @@ pre-commit run --all-files
165154
Before submitting your PR, ensure:
166155

167156
- [ ] Code follows the project's style guidelines
168-
- [ ] All tests pass (`pytest`)
169-
- [ ] New tests added for new features
157+
- [ ] Linting passes (`npm run lint`)
158+
- [ ] Build succeeds (`npm run build`)
159+
- [ ] New tests added for new features (if applicable)
170160
- [ ] Documentation updated (if applicable)
171161
- [ ] Commit messages follow guidelines
172162
- [ ] No merge conflicts with main branch
@@ -175,23 +165,24 @@ Before submitting your PR, ensure:
175165

176166
## 🎨 Style Guidelines
177167

178-
### Python Style Guide
168+
### JavaScript/React Style Guide
179169

180-
We follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) with some modifications:
170+
We follow modern JavaScript and React best practices:
181171

182172
- **Line length**: Maximum 100 characters
183-
- **Indentation**: 4 spaces (no tabs)
173+
- **Indentation**: 2 spaces (no tabs)
184174
- **Quotes**: Use double quotes for strings
185175
- **Imports**: Group and sort imports (use `isort`)
186176
- **Type hints**: Use type hints for function signatures
187177
- **Docstrings**: Use Google-style docstrings
188178

189179
### Example Code Style
190180

191-
```python
192-
from typing import Dict, List, Optional
181+
```javascript
182+
// Use modern ES6+ syntax
183+
import { encrypt } from './crypto';
193184

194-
def encrypt_secret(secret: str, key: bytes) -> bytes:
185+
const encryptSecret = async (secret, key) => {
195186
"""Encrypts a secret using the provided key.
196187
197188
Args:
@@ -329,7 +320,8 @@ All contributors will be:
329320
330321
- [GitHub Flow Guide](https://guides.github.com/introduction/flow/)
331322
- [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
332-
- [Python Best Practices](https://docs.python-guide.org/)
323+
- [JavaScript Best Practices](https://github.com/ryanmcdermott/clean-code-javascript)
324+
- [React Best Practices](https://react.dev/learn)
333325
- [Hacktoberfest Official Site](https://hacktoberfest.com/)
334326
335327
---

SETUP_CHECKLIST.md

Lines changed: 51 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,18 @@ All necessary files have been created! Here's what we have:
5959
```
6060
hacktoberfest
6161
hacktoberfest2025
62-
python
62+
nodejs
63+
electron
64+
react
6365
environment-variables
6466
secrets-management
6567
encryption
66-
cli
68+
desktop-app
6769
developer-tools
6870
open-source
6971
good-first-issue
72+
prisma
73+
sqlite
7074
```
7175

7276
#### Enable Security Features
@@ -107,117 +111,66 @@ gh auth login
107111

108112
Create some beginner-friendly issues to get started:
109113

110-
- [ ] **Issue 1**: Set up project structure
111-
- Create `src/`, `tests/`, `docs/` directories
112-
- Label: `good first issue`, `hacktoberfest`
114+
- [ ] **Issue 1**: Add search/filter functionality
115+
- Filter environment variables by key/value
116+
- Label: `good first issue`, `hacktoberfest`, `enhancement`
113117

114-
- [ ] **Issue 2**: Create requirements.txt
115-
- Add necessary dependencies
116-
- Label: `good first issue`, `hacktoberfest`
118+
- [ ] **Issue 2**: Add dark/light theme toggle
119+
- Implement theme switcher
120+
- Label: `good first issue`, `hacktoberfest`, `ui`
117121

118-
- [ ] **Issue 3**: Implement basic CLI structure
119-
- Use Click framework
120-
- Label: `enhancement`, `cli`
122+
- [ ] **Issue 3**: Add password strength indicator
123+
- Visual feedback for password creation
124+
- Label: `enhancement`, `security`
121125

122-
- [ ] **Issue 4**: Add encryption module
123-
- Implement AES-256 encryption
124-
- Label: `enhancement`, `crypto`
126+
- [ ] **Issue 4**: Add export templates
127+
- Support for different .env formats
128+
- Label: `enhancement`, `feature`
125129

126130
- [ ] **Issue 5**: Write documentation
127-
- Installation guide
128-
- User guide
131+
- User guide improvements
132+
- API documentation
129133
- Label: `documentation`, `good first issue`
130134

131135
### 4. Project Structure Setup
132136

133-
Create the basic project structure:
137+
The project structure is already set up:
134138

135-
```bash
136-
# Create directories
137-
mkdir -p src/{core,cli,gui,crypto,utils}
138-
mkdir -p tests/{unit,integration}
139-
mkdir -p docs
140-
mkdir -p examples
141-
142-
# Create __init__.py files
143-
touch src/__init__.py
144-
touch src/core/__init__.py
145-
touch src/cli/__init__.py
146-
touch src/gui/__init__.py
147-
touch src/crypto/__init__.py
148-
touch src/utils/__init__.py
149-
touch tests/__init__.py
150-
151-
# Create main entry point
152-
touch src/main.py
153-
touch setup.py
139+
```
140+
ENV_Storage/
141+
├── electron/ # Electron main process
142+
├── src/ # React frontend
143+
│ ├── components/ # React components
144+
│ ├── lib/ # Utility functions
145+
│ └── assets/ # Static assets
146+
├── prisma/ # Database schema
147+
├── public/ # Public assets
148+
└── docs/ # Documentation
154149
```
155150

156-
### 5. Create Essential Files
151+
### 5. Essential Files Already Created
157152

158-
#### requirements.txt
159-
```python
160-
cryptography>=41.0.0
161-
click>=8.1.0
162-
sqlalchemy>=2.0.0
163-
python-dotenv>=1.0.0
164-
rich>=13.0.0
165-
```
153+
All essential files are already in place:
166154

167-
#### requirements-dev.txt
168-
```python
169-
pytest>=7.4.0
170-
pytest-cov>=4.1.0
171-
pytest-xdist>=3.3.0
172-
black>=23.7.0
173-
flake8>=6.1.0
174-
isort>=5.12.0
175-
mypy>=1.5.0
176-
pylint>=2.17.0
177-
bandit>=1.7.0
178-
safety>=2.3.0
179-
pre-commit>=3.3.0
180-
```
155+
#### package.json
156+
- Contains all Node.js dependencies
157+
- Defines npm scripts for development and building
158+
- Configured for Electron desktop app
181159

182-
#### setup.py
183-
```python
184-
from setuptools import setup, find_packages
185-
186-
setup(
187-
name="env-storage",
188-
version="0.1.0",
189-
packages=find_packages(),
190-
install_requires=[
191-
"cryptography>=41.0.0",
192-
"click>=8.1.0",
193-
"sqlalchemy>=2.0.0",
194-
"python-dotenv>=1.0.0",
195-
"rich>=13.0.0",
196-
],
197-
entry_points={
198-
"console_scripts": [
199-
"env-storage=src.main:cli",
200-
],
201-
},
202-
author="Nitya Jain",
203-
description="Secure environment variable storage manager",
204-
long_description=open("README.md").read(),
205-
long_description_content_type="text/markdown",
206-
url="https://github.com/curiouscoder-cmd/ENV_Storage",
207-
classifiers=[
208-
"Development Status :: 3 - Alpha",
209-
"Intended Audience :: Developers",
210-
"License :: OSI Approved :: MIT License",
211-
"Programming Language :: Python :: 3",
212-
"Programming Language :: Python :: 3.8",
213-
"Programming Language :: Python :: 3.9",
214-
"Programming Language :: Python :: 3.10",
215-
"Programming Language :: Python :: 3.11",
216-
"Programming Language :: Python :: 3.12",
217-
],
218-
python_requires=">=3.8",
219-
)
220-
```
160+
#### prisma/schema.prisma
161+
- Database schema for SQLite
162+
- Models for Config, Project, EnvVar, and AuditLog
163+
164+
#### electron/
165+
- `main.js` - Electron main process
166+
- `preload.js` - IPC bridge
167+
- `ipc-handlers.js` - Backend handlers
168+
- `crypto.js` - Encryption utilities
169+
- `database.js` - Prisma client
170+
171+
#### src/
172+
- React components and application logic
173+
- Modern UI with Ant Design and Tailwind CSS
221174

222175
### 6. Git Configuration
223176

0 commit comments

Comments
 (0)