# Node-Based Carpooling System

A web application for carpooling built with Django, Docker, PostgreSQL, and Nginx. Users can create trips, request rides, and manage driver offers. This project is deployed on an AWS EC2 VPS but cannot be accessed publicly for now(**...previously deployed on AWS EC2, but it is no longer hosted.**).

## Features

* **Drivers:** Can create trips and set availability.
* **Passengers:** Can request carpools and view available drivers.
* **Logic:** Dynamic calculation of fares and detours.
* **Management:** Admin interface for managing users and trips (Django admin).
* **Infrastructure:** Fully containerized with Docker for easy deployment.
* **Google OAuth 2.0** Has Also been Added.

## Tech Stack

* **Backend:** Django 5.2
* **Frontend:** Django Templates + AI
* **Database:** PostgreSQL
* **Server & Deployment:** Docker, Gunicorn, Nginx, AWS EC2
* **Other:** REST Framework for API endpoints

## Setup & Installation

1.  **Clone the repo:**
    ```bash
    git clone [https://github.com/Lazy-Pir8/Node-Based-Carpooling-System.git](https://github.com/Lazy-Pir8/Node-Based-Carpooling-System.git)
    cd Node-Based-Carpooling-System
    ```

2.  **Environment Setup:**
    Create a `.env` file in the root directory with your settings (example variables: `DJANGO_SECRET_KEY`, `DATABASE_NAME`, `DATABASE_USER`, etc.).

3.  **Build and run with Docker:**
    ```bash
    docker compose up --build -d
    ```

4.  **Apply migrations and create a superuser:**
    ```bash
    docker exec -it carpool_web python manage.py migrate
    docker exec -it carpool_web python manage.py createsuperuser
    ```

5.  **Access the site locally:**
    [http://localhost:8000](http://localhost:8000)

## Admin Panel

* **URL:** `http://whateverIp/admin`
* **Note:** A dedicated admin page hasn't been created yet, so the project uses the default Django administration for now.
* **Access:** Use the superuser credentials created during the setup steps.
username - admin
pass - admin@123

## Project Structure

```text
Node-Based-Carpooling-System/
├─ carpool/              # Django project settings
├─ users/                # Custom user app
├─ trips/                # Carpooling trips & requests
├─ network/              # Nodes, points, and other location models
├─ Dockerfile
├─ docker-compose.yml
└─ .env                  # Environment variables (not pushed!)

## Deployment

* Hosted on **AWS EC2** using Docker and Nginx.
* Connected to a custom domain: **https://pir8lab.me**
* **HTTPS enabled** using Let's Encrypt (Certbot).
* Reverse proxy handled by Nginx.
* Application served via Gunicorn inside Docker containers.

### CI/CD(**No Longer Works, I stopped it too, was a bit annoying**)

* Automated deployment using GitHub Actions.
* On every push to `main`:
  - Code is pulled on the EC2 instance
  - Containers are rebuilt
  - Database migrations are applied
  - Application is restarted

### SSL Setup (** Removed it Too)

* SSL certificates generated using Certbot.
* Certificates mounted into Docker Nginx container.
* HTTP traffic automatically redirected to HTTPS.

## Continuous Deployment

The project uses GitHub Actions for automated deployment.

### Workflow

1. Push changes to `main` branch
2. GitHub Actions connects to EC2 via SSH
3. Runs:
   ```bash
   git pull
   docker-compose up --build -d
   docker-compose exec django-web python manage.py migrate
-  Location - Workflow File
.github/workflows/deploy.yml

## Architecture

* Nginx handles incoming HTTP/HTTPS requests
* Django processes business logic
* PostgreSQL stores persistent data
* Docker manages containerized services


## Notes

* **Security:** Ensure `.env` is included in your `.gitignore` and never committed to the repository as it contains sensitive keys.
* **Maintenance:** Always run migrations after pulling new updates:
    ```bash
    docker exec -it carpool_web python manage.py migrate
    ```

---