TechShe - Ride-sharing for Women

TechShe is a comprehensive ride-sharing platform designed specifically for women, providing safe, secure, and comfortable transportation options. The platform connects female passengers with female drivers, creating a trusted community for women's transportation needs.

Project Overview

TechShe consists of:

1. Frontend: A React-based web application providing user interfaces for passengers and drivers
2. Backend: A Django REST API handling business logic, authentication, and data storage

Key Features

• User Authentication: Secure login and registration system for both passengers and drivers
• Ride Booking: Simple interface for booking and scheduling rides
• Driver Matching: Intelligent matching of passengers with nearby drivers
• Profile Management: Comprehensive user profiles for both passengers and drivers
• Ride History: Detailed history of past rides and upcoming bookings
• Payment Integration: Secure payment processing for ride fares
• Rating System: Two-way rating system for quality assurance
• Safety Features: Emergency contacts, ride sharing, and real-time tracking

Tech Stack

Frontend

• React.js
• React Router for navigation
• Tailwind CSS for styling
• Axios for API requests
• Context API for state management

Backend

• Django
• Django REST Framework
• PostgreSQL for database
• JWT for authentication

Project Structure

techshe/
├── frontend/                # React frontend application
│   ├── public/              # Static files
│   │   ├── assets/          # Images and other assets
│   │   ├── components/      # Reusable UI components
│   │   ├── contexts/        # React contexts
│   │   ├── pages/           # Application pages
│   │   ├── services/        # API services
│   │   └── utils/           # Utility functions
│   ├── package.json         # Frontend dependencies
│   └── README.md            # Frontend documentation
│
├── backend/                 # Django backend application
│   ├── api/                 # API endpoints
│   ├── authentication/      # Authentication logic
│   ├── rides/               # Rides management
│   ├── profiles/            # User profiles
│   ├── payments/            # Payment processing
│   └── README.md            # Backend documentation
│
└── README.md                # Main project documentation

Getting Started

Prerequisites

• Node.js (v14.0.0 or later)
• Python (v3.8 or later)
• PostgreSQL

Running the Frontend

1. Navigate to the frontend directory:

   cd frontend
   

2. Install dependencies:

   npm install
   

3. Start the development server:

   npm start
   

4. Access the frontend at http://localhost:3000

Running the Backend

1. Navigate to the backend directory:

   cd backend
   

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

3. Install dependencies:

   pip install -r requirements.txt
   

4. Apply migrations:

   python manage.py migrate
   

5. Start the development server:

   python manage.py runserver
   

6. Access the API at http://localhost:8000/api/

Design Philosophy

TechShe follows a user-centered design approach with a focus on safety and ease of use. The application uses a clean, modern interface with a navy and white color scheme, accented with pink/red highlights that reflect the brand's focus on women-centric services.

Contributing

We welcome contributions to TechShe! Please read our contribution guidelines to get started.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

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

Contact

For questions or support, please contact: support@techshe.com