SETaP 7D1 - Chatlus Documentation

Chatlus is a novel Instant Messenger app that prioritises local connection through location-separated chatrooms.

Note

This project is under active development.

Contents

• User Guide
  • Installation
  • Onboarding
• Developer Guide
  • Backend
    • Install Guide
    • Usage Guide
    • Components
  • Frontend
    • Prerequisites
    • Install Guide
    • Test Instructions
    • Build Instructions
  • Developer Goals
  • Helpful Tips
• API Usage
  • API Description
  • Model Documentation
  • Endpoint Documentation
    • Attachments
    • Auth
    • Blocks
    • Chatrooms
    • DM Requests
    • Friend Requests
    • Map
    • Mentions
    • Messages
    • Notifications
    • Reports
    • Users
• Backend Components
  • Chatroom Manager
  • Database Manager
  • Location Manager
  • User Manager
  • Validation Manager
• Frontend Screens
  • Login / Title Screen
  • Navigation Shell
  • Home Screen
  • Map Screen
  • Messages Screen
  • Notification Settings Screen
  • Profile Screen
  • Settings Screen
  • Blocked Users Screen
  • Privacy Settings Screen
  • Notification Settings Screen
  • About Screen
  • Friend List Screen
  • Friend Profile Screen
  • Non-Friend Profile Screen
  • Group Chats List
  • Group Chat Screen
  • Direct Message Chat Screen
  • Group Info Screen
  • Non-Member Group Info Screen
  • Create Group Screen
  • DM Request Screen
• Frontend Documentation
  • All
    • main.dart
    • app_session.dart
      • Dev Variables
  • Groups
    • create_group.dart
    • group_chat_list.dart
    • group_chat_page.dart
    • group_info.dart
    • user_chatroom_page.dart
  • Messages
    • dm_chat_page.dart
    • dm_list.dart
    • dm.dart
  • Services
    • api_client.dart
    • attachment_service.dart
    • auth_services.dart
    • block_services.dart
    • chatrooms_services.dart
    • dm_request_services.dart
    • friend_request_services.dart
    • friends_services.dart
    • message_services.dart
    • notification_services.dart
    • user_service.dart
  • Theme
    • app_colour.dart
    • app_spacing.dart
    • app_text_style.dart
    • app_theme.dart
  • Views
    • blocked_user.dart
    • dm_request.dart
    • friend_list.dart
    • friend_profile.dart
    • home_page_screen.dart
    • login_page_screen.dart
    • map_area.dart
    • map_screen.dart
    • navigation_screen.dart
    • non_friend_page.dart
    • non_member_group.dart
    • notification_page_screen.dart
    • notification_settings_screen.dart
    • privacy_settings_screen.dart
    • profile_page_screen.dart