Skip to content

Latest commit

 

History

28 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aidlyn - Premium Emergency QR System 🛡️

A modern, mobile-first web application designed to secure vehicles and provide an instant emergency contact system via a beautifully designed QR code sticker.

Aidlyn ensures that helpers and rescuers can notify you about your vehicle (Accidents, Windows Left Open, Blocking the Way) without you having to expose your private phone number to the public.

Aidlyn Preview React NodeJS

✨ Key Features

  • Dynamic QR Generation: Generates high-quality, print-ready QR stickers with distinct layouts for Cars (Standard Windshield) and Bikes (Compact Square).
  • True Cross-Theme Support: Fully responsive Light and Dark modes with seamless CSS variable integration.
  • Glassmorphism UI: Premium "Bento Grid" layout with dynamic hovering, sophisticated typography, and engaging micro-animations.
  • Total Privacy: Users can instantly toggle their contact visibility on or off. Rescuers don't need an app to scan or report an incident.
  • Smart WhatsApp Integration: Allows rescuers to send a pre-formatted WhatsApp message with one tap.
  • Live Location Sharing: Rescuers can opt-in to attach their precise GPS location, instantly sending the owner a tap-to-navigate Google Maps link to the vehicle's location.
  • Installable Native-like App (PWA): Users can directly install Aidlyn to their home screens as a Progressive Web App, no App Store required!

📱 App Installation (PWA)

Aidlyn is built as a Progressive Web App (PWA). This means you and your users can install it as a fully-functional App directly from the browser:

  • Android/Chrome: Visit the site and tap "Install Aidlyn" from the prompt or browser menu.
  • iOS/Safari: Visit the site, tap the "Share" icon, and select "Add to Home Screen". The app features true offline-caching and a full-screen, native-like experience.

🚀 Local Development Quick Start

If you are running the project locally, you can use the built-in root scripts:

  1. Install Dependencies (First time only):

    npm run install-all
  2. Start the App:

    npm run dev

    This concurrently starts the Node/Express Backend on http://localhost:3000 and the Vite React Frontend on http://localhost:5173.

📂 Architecture

  • server/ - Node.js + Express
    • Uses better-sqlite3 for high-performance local database.
    • JWT Authentication for secure owner dashboards.
  • client/ - React + Vite
    • Custom CSS Design System (index.css & CSS Variables).
    • Component-based architecture with lucide-react icons.

🌐 Production Deployment Guide

Aidlyn is structured to be easily deployed to modern cloud providers.

1. Deploying the Backend (Render / Railway)

  1. Commit the code to GitHub.
  2. In your hosting provider, create a new Web Service and link your repository.
  3. Set the Root Directory to server.
  4. Build Command: npm install
  5. Start Command: npm start (or node src/index.js)
  6. Environment Variables: Add JWT_SECRET with a secure random string.

2. Deploying the Frontend (Vercel)

  1. Link your GitHub repository to Vercel.
  2. Set the Root Directory to client.
  3. Vercel will automatically detect Vite and run npm run build.
  4. Important: Because the frontend uses Vite's proxy locally, you must create a vercel.json in the client directory to proxy /api routes to your live backend URL:
    {
      "rewrites": [
        {
          "source": "/api/(.*)",
          "destination": "https://<YOUR_RENDER_URL>/api/$1"
        },
        {
          "source": "/(.*)",
          "destination": "/index.html"
        }
      ]
    }

🔒 Security Summary

  • Passwords are cryptographically hashed using bcryptjs.
  • Session management is handled securely via HttpOnly cookies and JSON Web Tokens.
  • No sensitive PII is exposed on the public QR page unless explicitly enabled by the owner.

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages