Skip to content

DeshnaDey/HerWay

Repository files navigation

HerWay -- MVP scaffold

Working-prototype scaffold of HerWay, a women-centered ride-hailing platform, built from HerWay_Project_Guide.pages.

HerWay/
  herway-db/         PostgreSQL schema + seed data
  herway-backend/    Node.js + Express + JWT API
  herway-frontend/   React 18 + Vite + Tailwind passenger app

Quick start

# 1. Database
createdb herway_db
psql -d herway_db -f herway-db/schema.sql

# 2. Backend
cd herway-backend
cp .env.example .env        # set DB creds + JWT_SECRET
npm install
npm run dev                 # :5000

# 3. Frontend (new terminal)
cd herway-frontend
cp .env.example .env
npm install
npm run dev                 # :5173

Open http://localhost:5173 and log in with the seeded account aanya@example.com / password123.

What's implemented

Feature Where
10-table schema (3NF) herway-db/schema.sql
JWT auth (user/driver) herway-backend/src/routes/auth.js
Pink Mode filtering routes/drivers.js + routes/rides.js (DB-enforced)
Wallet + transactions routes/wallet.js, routes/rides.js (auto-charge on done)
SOS alerts routes/sos.js + components/SOSButton.jsx
Reviews + driver rating routes/reviews.js
Rate limiting + helmet src/server.js
Tailwind UI herway-frontend/src/...

What's intentionally not in the MVP

  • No real maps integration (Google Maps/Mapbox) -- lat/lng entered manually
  • No WebSocket live tracking -- planned via polling endpoint
  • No SMS dispatch from SOS -- a console.log placeholder marks where to wire Twilio
  • No admin dashboard, no driver app
  • No automated tests -- Jest setup is straightforward to add later

These are called out in the project guide section 7 as next steps.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors