Skip to content

devgateway/digital-safety-guide

Repository files navigation

Gabay Tech

A comprehensive, multilingual digital safety guide designed to support individuals navigating online harassment and complex digital safety situations. This platform provides actionable advice through logic-based workflows and specialized resources.

🚀 Features

  • Multilingual Support: Available in English and Taglish (Tagalog-English) to ensure accessibility.
  • Interactive Logic Trees: Guided questionnaires that lead users to specific, actionable advice based on their situation.
  • Resource Repository: Curated links to hotlines, reporting tools, and support organizations.
  • PDF Generation: Users can download localized guides and action plans for offline reference.
  • Stateless Architecture: Simplified deployment with no backend database requirement. The provided Express server is entirely optional and only serves the compiled static frontend files.

🛠️ Tech Stack

  • Frontend: React 19, Vite, Lucide React (Icons), jsPDF (PDF generation).
  • Backend: Express (Static file serving and health checks).
  • Tooling: ESLint, Vite.

📂 Project Structure

.
├── client/                 # React Frontend
│   ├── public/             # Static assets (data, images)
│   ├── src/                # Source code
│   │   ├── components/     # UI Components
│   │   ├── locales/        # Translation files (i18n)
│   │   └── utils/          # Helper functions
│   └── scripts/            # Build and data processing scripts
├── server/                 # Express Backend (Static server)
│   └── server.js           # Server configuration
└── analysis.js             # Workflow analysis utility

🏁 Getting Started

Prerequisites

  • Node.js (v18+ recommended)
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/devgateway/digital-safety-guide.git
    cd digital-safety-guide
  2. Setup Client:

    cd client
    npm install
  3. Setup Server:

    cd ../server
    npm install

Running Locally

To run the application for development, you typically want to start the client:

cd client
npm run dev

For production-like environment testing, build the client and run the server:

cd client
npm run build
cd ../server
node server.js

The server will be running at http://localhost:3000.

📜 Deployment

The application is designed to be served as a static site and can be deployed to any static hosting provider (e.g., GitHub Pages, Vercel, Netlify). The Express server included in the server/ directory is entirely optional and is only provided as a convenient method to serve the built contents of the client/dist directory. You do not need a Node.js backend to run this application in production.

🤝 Contributing

We welcome contributions! Please feel free to submit issues or pull requests.

⚖️ License

This project is licensed under the MIT License - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors