Name: Uttams Emmanuel
Student ID: 1422330
Center Name: Aptech, Abeokuta
Project Name: Citi Guide
Acknowledgement:
This comprehensive documentation stands as a testament to the collaborative effort
and dedication of all those involved in the development of the City Guide Mobile
App. In particular, I extend my deepest gratitude to my team members whose
relentless commitment and expertise have been instrumental in bringing this project
to fruition. Special thanks are also due to [mention specific individuals or
departments if applicable] for their invaluable support and guidance throughout this
[Link] deepest gratitude to the project team and those who gave us this
project to test our development in mobile app development.
Project Documentation: City Guide Mobile App
Table of Contents
Project Documentation: City Guide Mobile App
Table of Contents
1. Introduction
Purpose
Scope
Audience
2. Functional Requirements
User Registration and Authentication
City Selection
Attraction Listings
Detailed Information
Maps and Directions
User Reviews and Ratings
Search Functionality
User Profile and Preferences
Admin Dashboard
3. Non-Functional Requirements
Responsiveness
Loading Time
User Interface
Accessibility
User-friendliness
Operability
Error Handling
Scalability
Security
User Documentation
Developer Documentation
4. Video Demonstration
5. Flowchart
1. Introduction
Purpose:
The City Guide mobile app is a digital platform designed to provide residents and
tourists with valuable information and recommendations for exploring and enjoying
a specific city. It serves as a user-friendly, all-in-one solution for discovering local
attractions, restaurants, events, accommodations, and more, leveraging the power
of mobile technology to enhance the city exploration experience.
Scope:
The scope of this project includes creating a mobile application using Flutter
framework that incorporates features enabling users to register and authenticate,
select a city, explore attraction listings, view detailed information, obtain maps and
directions, leave reviews and ratings, utilize search functionality, manage user
profiles and preferences, and administer attraction listings, reviews, and
notifications.
Audience:
This app caters to residents and tourists of the respective cities, providing them with
a convenient platform for exploring and discovering local attractions. Additionally,
administrators responsible for managing the app's content are also part of the target
audience.
2. Functional Requirements
User Registration and Authentication:
Implemented user registration functionality allowing users to securely create
accounts.
Developed authentication system enabling users to securely log in and access
personalized features and settings.
Included password reset option for user convenience.
City Selection:
Enabled users to browse and select a city from a list of available cities.
Incorporated city information display, including descriptions and images.
Attraction Listings:
Developed a feature to display popular attractions, restaurants, hotels, and events in
the selected city.
Implemented filtering and sorting options for attraction listings based on categories
and ratings.
Included attraction listings containing name, image, description, contact information,
opening hours, and user ratings.
Detailed Information:
Enabled users to view detailed information about each attraction by tapping on a
listing.
Included additional images, location on the map, user reviews, and a link to the
attraction's website in the detailed information section.
Maps and Directions:
Integrated a map with markers for attractions.
Implemented functionality allowing users to obtain directions to an attraction from
their current location.
User Reviews and Ratings:
Developed a system for users to leave reviews and ratings for attractions they have
visited.
Included text comments and star ratings in reviews.
Implemented functionality for users to like helpful reviews.
Search Functionality:
Developed search functionality allowing users to search for specific attractions,
restaurants, or events by name or keywords.
Included search filters to assist users in finding desired information.
User Profile and Preferences:
Implemented user profile management, allowing users to view and edit their
profiles, including name, profile picture, and contact information.
Developed functionality for users to set preferences, including favorite attractions
and notification settings.
Admin Dashboard:
Created an admin dashboard to manage attraction listings, reviews, and
notifications.
Enabled admins to add, edit, or remove attractions, events, and other content.
3. Non-Functional Requirements
Responsiveness:
Ensured app responsiveness to user interactions within 1-2 seconds, providing a
smooth and lag-free experience.
Loading Time:
Minimized the app's initial loading time to ensure quick access for users.
User Interface:
Designed an intuitive user interface following best design practices for mobile apps
to ensure ease of use.
Accessibility:
Ensured clear and legible fonts, user-interface elements, and navigation elements for
enhanced accessibility.
User-friendliness:
Designed the application to be easy to navigate with clear menus and elements for
improved user experience.
Operability:
Developed the application to operate reliably and efficiently.
Error Handling:
Implemented robust error handling to provide clear error messages to users and
gracefully handle unexpected situations.
Scalability:
Designed the application architecture and infrastructure to handle increasing user
traffic, data storage, and feature expansions.
Security:
Implemented adequate security measures such as authentication to ensure user
data safety and privacy.
User Documentation:
Provided user guides, FAQs, and tutorials to assist users in understanding and
navigating the application.
Developer Documentation:
Maintained developer documentation to aid in further development and
maintenance of the application.
4. Video Demonstration
A video demonstrating the complete working of the application will be provided to
showcase its features and functionalities in action.
5. Screen shots
6. Flowchart
