Skip to content

Fargolnz/Tik

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

70 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“‹ Tik - Smart Emergency Preparedness System

A personalized crisis preparedness platform designed to help families prepare for emergency situations by generating customized checklists and action plans based on their specific needs.


๐Ÿ“Œ Project Overview

Tik is a full-stack web application that helps individuals and families prepare for emergency situations through personalized planning and secure profile management.

The system allows users to create an account, build a household profile, and securely store their preparedness information.

The system collects information about household members and special conditions, such as:

  • ๐Ÿ‘ถ๐Ÿป Children
  • ๐Ÿ‘ต๐Ÿป Elderly family members
  • ๐Ÿฑ Pets
  • ๐Ÿ’Š Medical conditions
  • ๐Ÿ  Residence conditions

Based on each household's characteristics, Tik automatically generates personalized emergency resources.

The platform currently provides:

  • โœ… Personalized emergency supply checklists
  • โšก Before, during, and after crisis action plans
  • ๐Ÿ‘ค Secure user accounts and profile management
  • ๐Ÿ“Š Readiness dashboard
  • ๐Ÿ“„ Multi-format exports
  • ๐Ÿ’พ Persistent data storage
  • ๐Ÿ” Authentication and secure access

The current version focuses on war-related emergency preparedness,helping families organize supplies and understand essential actions during critical situations.

Tik is designed with a scalable architecture that enables continuous expansion through new crisis scenarios, advanced emergency management features, and future service integrations.


โœจ Features

๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Personalized Household Assessment

Build a customized emergency preparedness profile based on your family's unique situation, including:

  • Number of family members
  • Children and infants
  • Elderly family members
  • People with disabilities
  • Chronic medical conditions
  • Medication requirements
  • Pets and animal care needs

This ensures that every recommendation is tailored specifically to your household.


๐Ÿ“‹ Smart Emergency Checklists

Automatically generate personalized emergency supply checklists based on the information provided by the user.

Generated checklists include:

  • Food and water supplies
  • Medical and first-aid equipment
  • Personal hygiene products
  • Infant and child necessities
  • Elderly care items
  • Pet supplies
  • Important documents
  • Communication and power backup equipment

Each item can be tracked and marked as completed to monitor preparedness progress.


๐Ÿšจ Crisis Action Guidance

Receive structured recommendations for every phase of a crisis situation:

๐Ÿ›ก๏ธ Before a Crisis

  • Family preparedness planning
  • Emergency contact organization
  • Shelter identification
  • Resource preparation

โšก During a Crisis

  • Immediate safety actions
  • Communication procedures
  • Shelter protocols
  • Family coordination guidelines

๐Ÿ”„ After a Crisis

  • Damage assessment
  • Family accountability checks
  • Access to emergency resources
  • Recovery and stabilization recommendations

๐Ÿ” Secure Authentication

Secure authentication ensures that each user's emergency data remains private and accessible only to authorized users. Household information, preparedness plans, and generated checklists are safely managed through a protected account system.

  • User registration
  • Secure login
  • JWT-based authentication
  • Password hashing using bcrypt
  • Persistent user sessions

๐Ÿ’พ Persistent Data Storage

User information, household profiles, generated checklists, and emergency plans are securely stored in a local SQLite database through the backend API.


๐Ÿ“Š Progress Tracking

Monitor preparedness progress in real time:

  • Track completed checklist items
  • View remaining tasks
  • Measure overall readiness level
  • Maintain organized preparation plans

๐Ÿ‘ค Household Profile Management

Users can securely manage their household profile.

Profile includes:

  • Family members
  • Children
  • Elderly
  • Medical conditions
  • Pets
  • Emergency information

๐Ÿ“„ Multi-Format Export System

Generated emergency plans can be exported in multiple formats:

  • ๐Ÿ“„ TXT for quick printing and sharing
  • ๐Ÿ—‚๏ธ JSON for data portability and integration
  • ๐ŸŒ HTML for visually formatted reports

This makes emergency information accessible both online and offline.


๐Ÿ“ฑ Mobile-First Experience

Designed primarily for smartphones while remaining fully usable on desktop devices.

Features include:

  • Responsive layouts
  • Touch-friendly interactions
  • Fast navigation
  • App-like user experience

๐ŸŽจ Modern User Interface

Built with modern frontend technologies to provide:

  • Smooth page transitions
  • Interactive components
  • Clean visual hierarchy
  • Accessible user experience
  • Fast and responsive interactions

๐Ÿ“ฑ Application Preview

๐Ÿ” Login

Secure authentication system with user registration and login, providing safe access to personalized emergency preparedness data.

Login


๐Ÿ“ Questionnaire

A guided multi-step assessment that collects household information to generate personalized emergency plans.

Questionnaire


๐Ÿ  Home Dashboard

A centralized dashboard that provides quick access to preparedness status, emergency resources, and the application's main features.

Home Dashboard


๐Ÿ‘ค Profile

Manage household information, review personal details, and update preparedness data at any time.

Profile


โœ… Emergency Checklist

Customized supplies and preparedness items generated based on household needs.

Checklist


๐Ÿšจ Action Plans

Personalized guidance covering essential actions before, during, and after emergency situations.

Actions


๐Ÿงฐ Tools

Access useful emergency utilities, preparedness resources, and supporting tools designed to improve household readiness.

Tools


๐Ÿ—‚๏ธ Project Structure

Tik/
โ”‚
โ”œโ”€โ”€ server/
โ”‚
โ”œโ”€โ”€ src/
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ app/
โ”‚   โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ api.ts
โ”‚   โ”‚   โ””โ”€โ”€ App.tsx
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ styles/
โ”‚   โ””โ”€โ”€ main.tsx
โ”‚ 
โ”œโ”€โ”€ screenshots/
โ”‚   โ””โ”€โ”€ mockups/
โ”‚
โ”œโ”€โ”€ index.html
โ”œโ”€โ”€ package-lock.json
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ postcss.config.mjs
โ”œโ”€โ”€ vite.config.ts
โ””โ”€โ”€ README.md

๐Ÿ—๏ธ System Architecture

Tik follows a modern full-stack architecture that separates the presentation layer, business logic, and data storage. This modular design improves maintainability, scalability, and makes future feature development significantly easier.

    User
    โ”‚
    โ–ผ
    โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
    โ”‚      React + TypeScript UI     โ”‚
    โ”‚        (Frontend - Vite)       โ”‚
    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
    โ”‚
    RESTful API (JSON)
    โ”‚
    โ–ผ
    โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
    โ”‚        Express.js Server       โ”‚
    โ”‚      Authentication & APIs     โ”‚
    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
    โ”‚
    โ–ผ
    โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
    โ”‚         SQLite Database        โ”‚
    โ”‚  Users โ€ข Profiles โ€ข Checklists โ”‚
    โ”‚    Actions โ€ข Emergency Data    โ”‚
    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
  

Architecture Highlights

  • โš›๏ธ React + TypeScript powers a responsive, mobile-first user interface.
  • ๐Ÿ”Œ RESTful APIs enable communication between the frontend and backend using JSON.
  • โš™๏ธ Express.js handles business logic, authentication, and data processing.
  • ๐Ÿ” JWT Authentication secures user sessions, while bcryptjs protects user passwords.
  • ๐Ÿ—„๏ธ SQLite stores user accounts, household profiles, generated checklists, emergency plans, and application data.
  • ๐Ÿ“ฆ The modular architecture makes it easy to extend the platform with new emergency scenarios, cloud synchronization, notifications, and additional services in future releases.

๐Ÿ› ๏ธ Technologies

โš™๏ธ Backend

  • Node.js
  • Express.js
  • SQLite
  • better-sqlite3
  • jsonwebtoken
  • bcryptjs

๐Ÿ’ป Frontend

  • React
  • TypeScript
  • Vite
  • Tailwind CSS

๐Ÿ”Œ APIs

  • RESTful API
  • JSON-based communication

๐ŸŽจ UI & Animation

  • Motion
  • Lucide React
  • Sonner

๐Ÿงฐ Utilities

  • React Hook Form
  • Date-fns
  • Recharts
  • Class Variance Authority
  • Tailwind Merge

๐Ÿš€ Installation

1. Clone the repository

git clone https://github.com/Fargolnz/Tik.git

2. Enter project directory

cd Tik

3. Install dependencies

npm install

โ–ถ๏ธ Running the Application

You can start the application using either of the following methods.

Option 1 โ€” Run Frontend & Backend Together (Recommended)

Start both the Express backend and the React frontend with a single command:

npm run dev:all

Option 2 โ€” Run Services Separately

Start the backend server

npm run server

Open a second terminal and start the frontend

npm run dev

Open the application

Once the development servers are running, open:

http://localhost:5173

The frontend will automatically communicate with the Express backend running in the background.


๐Ÿ“ฆ Build for Production

npm run build

The production-ready frontend files will be generated inside:

dist/

๐Ÿ”ฎ Planned Features

โ˜๏ธ Cloud Synchronization

Keep preparedness data available across multiple devices through secure cloud storage.

Planned capabilities:

  • Automatic data synchronization
  • Cloud backup & recovery
  • Multi-device access
  • Secure online storage

๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘ง Advanced Household Management

Expand profile capabilities beyond a single questionnaire.

Future improvements:

  • Multiple household profiles
  • Family member management
  • Medical information tracking
  • Emergency contact management
  • Caregiver and dependent support

๐Ÿ›ก๏ธ War Preparedness Expansion

Introduce advanced preparedness tools specifically designed for conflict and wartime scenarios.

Planned features include:

  • Shelter and safe-room planning
  • Emergency evacuation planning
  • Family reunification procedures
  • Safe-route recommendations
  • Emergency communication plans
  • Essential document protection guidance
  • Supply duration estimation
  • Location-based preparedness recommendations

๐Ÿ“ฆ Emergency Inventory Management

Allow users to maintain a digital inventory of emergency supplies.

Future capabilities:

  • Track owned emergency items
  • Monitor quantities
  • Record expiration dates
  • Receive replenishment reminders

๐Ÿ“ Nearby Emergency Resources

Help users identify critical services during emergencies.

Potential integrations:

  • Hospitals
  • Pharmacies
  • Emergency shelters
  • Humanitarian aid centers
  • Relief distribution points

๐Ÿšจ Smart Alerts & Notifications

Keep users informed and prepared.

Planned notifications:

  • Checklist completion reminders
  • Medication renewal reminders
  • Emergency preparedness updates
  • Supply expiration alerts
  • Family safety review reminders

๐Ÿค– Intelligent Recommendation Engine

Use household data to provide smarter preparedness suggestions.

Future versions may offer:

  • Dynamic risk assessment
  • Personalized emergency planning
  • Resource prioritization
  • Family-specific recommendations
  • Adaptive preparedness scoring

๐ŸŒ Multi-Crisis Support

Although Tik currently focuses on wartime preparedness, future versions may support additional crisis scenarios:

  • ๐ŸŒŽ Earthquakes
  • ๐ŸŒŠ Floods
  • ๐Ÿ”ฅ Fires
  • ๐ŸŒช๏ธ Severe weather events
  • โš ๏ธ Infrastructure disruptions
  • ๐Ÿ”Œ Long-term power outages
  • โ˜ฃ๏ธ Hazardous material incidents

Each scenario will provide specialized checklists and action plans.


๐ŸŽฏ Project Goals

The main objective of Tik is to improve family preparedness by:

  • Reducing panic during emergencies
  • Providing personalized recommendations
  • Organizing essential supplies
  • Increasing awareness of emergency procedures
  • Helping families create practical preparedness plans
  • Personalized household profiles
  • Long-term preparedness management

๐ŸŽ“ Academic Project

This project is developed as part of IT Project Management course.


๐Ÿค๐Ÿป Acknowledgments

  • IT Project Management Course
  • Faculty of Farabi, University of Tehran
  • Academic Year 1404โ€“1405

About

Smart emergency preparedness system that generates personalized crisis checklists and action plans based on household needs.

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Contributors