Welcome to Keycode Help, the all-in-one platform designed to revolutionize the workflow of locksmiths and automotive professionals working with key systems, smart key programming, and transponder chips.
🚗 Keycode Help simplifies the complex processes of VIN to Keycode conversion, key type identification, programming instructions, and real-time tech support — all at your fingertips.
Input a Vehicle Identification Number (VIN) and instantly receive the corresponding keycode. No more manual processes — with Keycode Help, it’s seamless, automated, and real-time!
Our innovative generator takes your keycode and decodes it into detailed key types. You'll get:
- Transponder chip information (chipset, frequency, etc.).
- Key blade compatibility.
- Smart key specifications.
Unlock the full potential of key types by accessing details about:
- Chip types (ID46, ID48, etc.).
- Transponder frequencies (433 MHz, 315 MHz).
- Key blade compatibility and more!
No guesswork! We provide detailed, vehicle-specific programming instructions for locksmiths and automotive professionals to ensure every job is done right.
Need help? Our platform integrates live chat support and offers a direct helpline. Get assistance from our experts while you work — whether it’s for troubleshooting, key programming, or any other support needs.
- Automated VIN to Keycode Retrieval: No more manual lookups. We automate the entire process for faster results.
- Keycode to Key Type Database & Generator: Quickly find out which key type fits the keycode, including transponder chip details.
- Real-Time Communication: Get instant updates on VIN to Keycode lookups and chat with our support team for any assistance.
- Mobile-Friendly Dashboard: Whether you're in the shop or on-site, our responsive UI works on all devices, ensuring you're never slowed down.
- Detailed Programming Guides: Access programming instructions specific to each key type and vehicle model — all downloadable for offline use.
At Keycode Help, we are committed to delivering a robust and efficient solution. For the MVP, we’re focusing on simplicity, performance, and scalability with the following tech stack:
- Node.js with Express.js: Lightweight, fast, and perfect for building REST API endpoints for VIN to Keycode services, authentication, and dashboard features.
- MySQL: A reliable relational database for structured data, storing user profiles, VINs, keycodes, and query history.
- JWT (JSON Web Tokens): For secure, stateless authentication and authorization.
- Bcrypt.js: For secure password hashing.
- Fastify: For performance-critical applications.
- Koa.js: For a minimal and modern alternative to Express.
- NestJS: If modular and scalable architecture is required in the future.
- HTML, Tailwind CSS, and Vanilla JavaScript: A lightweight, flexible approach for building the initial MVP. Tailwind CSS ensures responsive and modern designs without writing custom styles from scratch.
- Postman: For API testing during backend development.
- Nodemailer: To send automated emails (e.g., user confirmations or VIN query results).
- GitHub Actions: For CI/CD pipelines, including automated testing and deployments.
- Stripe: Secure payment processing and subscription management.
- Represents the stable, tested, and ready-for-release code.
- Used for production deployments.
- Only merge into
mainafter thorough testing on theproductionbranch.
- Serves as the integration branch for new features and fixes.
- Collaborators push changes (via feature branches) to
dev. - Regularly tested to ensure all changes are working as expected.
- Used to simulate the production environment and test the application.
- Changes are merged from
devintoproductionfor final testing before deploying tomain.
git clone https://github.com/Keycode-Help/KeycodeHelpDev1
cd keycode-help
### 2. Backend Setup
1. Navigate to the backend directory:
bash
Copy code
`cd kch-backend`
2. Install dependencies:
bash
Copy code
`npm install`
3. Set up environment variables in a `.env` file:
plaintext
Copy code
`DB_HOST=localhost
DB_USER=root
DB_PASSWORD=password
DB_NAME=keycode_help
JWT_SECRET=your_jwt_secret`
4. Start the backend server:
bash
Copy code
`npm run dev`
### 3. Frontend Setup
1. Navigate to the `frontend/` directory:
bash
Copy code
`cd kch-frontend`
2. Open `index.html` in your browser to view the application.
----------
## 🤝 Contribution Guide
We welcome contributions from developers! To contribute:
1. Fork the repository.
2. Create a new branch:
bash
Copy code
`git checkout -b feature-branch`
3. Commit your changes:
bash
Copy code
`git commit -m 'Add a new feature'`
4. Push to the branch:
bash
Copy code
`git push origin feature-branch`
5. Open a Pull Request on GitHub.
----------
## Workflow
### 1. Local Development (Feature Branches)
Developers create feature branches from `dev`:
bash
Copy code
`git checkout dev
git pull origin dev
git checkout -b feature/<feature-name>`
Work on the feature locally, stage, and commit changes:
bash
Copy code
`git add .
git commit -m "Implement feature <feature-name>"`
Push the feature branch:
bash
Copy code
`git push origin feature/<feature-name>`
### 2. Merge into Dev
- Open a pull request (PR) to merge the feature branch into `dev`.
- Perform code reviews, testing, and resolve conflicts before merging.
### 3. Testing in Production Branch
Once the `dev` branch is stable, merge it into `production`:
bash
Copy code
`git checkout production
git merge dev
git push origin production`
Perform final tests in a pre-release environment.
### 4. Deploy to Main
After successful testing in `production`, merge changes into `main`:
bash
Copy code
`git checkout main
git merge production
git push origin main`
----------
## 📚 Documentation
- [Technical Architecture Document (TAD)](docs/Technical%20Architecture%20Document%20TAD.md)
- [Backend Documentation](docs/backend_documentation.md)
- [Frontend Documentation](docs/frontend_documentation.md)
- [Testing Guidelines](docs/testing_guidelines.md)
# Updated Wed Aug 20 00:21:01 EDT 2025