TaB (Track and Be Safe)

About

TaB is an app that keeps you informed about local events and potential risks. It uses web-scraping and real-time data analysis to provide up-to-the-minute information on events happening around you and future occurrences.

Key Features

1. Event Tracking (Personal/Group)
2. User-Friendly Design (Mobile Compatible)
3. Danger Assessment System (Notification) and News Components
4. User Customisable Permissions and Groups (Django)

Future Features

• Interactive Map Interface
• Customisable Alerts
• Comprehensive Event Details
• User Details

Tech Stack

• Frontend: React, NextUI
• Backend: Django
• Database: PostgreSQL
• Containerization: Docker

Getting Started

Prerequisites

• Docker and Docker Compose installed on your machine

Running the Application

1. Clone the repository:

   git clone https://github.com/yourusername/TaB.git
   cd TaB

2. Build and start the containers:

   docker compose up --build

3. Access the application:

   • Frontend: http://localhost:3000
   • Backend API: http://localhost:8000
   • Admin panel: http://localhost:8000/admin

Useful Docker Commands

• Start all services: docker-compose up
• Start in detached mode: docker-compose up -d
• Stop all services: docker-compose down
• View logs: docker-compose logs -fv
• Rebuild specific service: docker-compose up -d --build <service-name>

Database Migrations

To run database migrations:

python manage.py migrate

Creating a Superuser

To create an admin superuser:

python manage.py createsuperuser

Screenshots

Resources

• Django Learning Resources
• NextUI Documentation
• Project Slides

License

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