Skip to content

devgateway/digital-safety-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Digital Safety Guide

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.

πŸ› οΈ 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. The Express server in the server/ directory is configured to serve the built contents of the client/dist directory.

🀝 Contributing

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

βš–οΈ License

All rights reserved by IREX and Development Gateway.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published