ride-app

A full-stack ride-sharing application built with Django (backend), Vite + React (frontend), Docker, and PostgreSQL.

Tech Stack

• Backend: Django + Django REST Framework

• Frontend: Vite + React

• Database: PostgreSQL

• Containerization: Docker + Docker Compose

• Testing: tox, pytest, coverage

• Dev Tools: Pre-commit, linters, formatters

• Other Tools: DBeaver

Quick Start

1. Set up environment variables

Create a copy of backend/.env.template and rename the new file to .env.

Change the environment values accordingly.

2. Build the docker containers

# run on development mode
./docker.sh up-build dev

Testing

tox -e py12 -- --tb=no

Check docs/testing.md for other useful tox commands.

Other django commands

# list all generated route names
python manage.py show_urls

Other docker script commands

# Start dev environment in background
./docker.sh up dev

# Tail logs for dev
./docker.sh logs dev

# Rebuild and start prod
./docker.sh up-build prod

# Exec into prod backend container
./docker.sh bash prod
# stop

Check docker.sh for more commands.

Additional Documentation

The API documentation can be accessed via http://localhost:8000/api/docs/. Note that this is only available on DEVELOPMENT mode.

Go to http://localhost:8000/api/schema/ to download the API Schema in OpenAPI format.

Miscellaneous documentation is available in the /docs/ directory:

• postgresql.md: Local PostgreSQL setup

• tools.md: Overview of tools and services used in the project

• django.md: Guide on generating fixtures, and how to load the fixtures.

• long_trip_report.md: Raw SQL query for the long trip report

Refer to these files for deeper configuration notes and development context.