Welcome to Student Map’s documentation!

The aim of the project is to provide University of Portsmouth students with an interactive map showing university buildings. The app allows the user to sign in with Google to display their university timetable within the app (subject to the user linking their port.ac.uk timetable with Google).

Although not yet implemented, the project aims to provide navigational features to the user, such as providing bus routes and walking paths to university buildings.

Check out the Usage section for further information, including how to Installation the project.

Note

This project is under active development.

Contents

• Usage
  • Installation
  • Running the project
• API
• Requirements Page
  • 1. View University Buildings on Interactive Map
  • 2. Distinguish University Buildings
  • 3. View Supermarkets and Stores
  • 4. Filter Displayed Buildings
  • 5. View Routes from Current Location (not yet implemented)
  • 6. Switch Between Transport Modes (not yet implemented)
  • 7. Check Transport Availability (not yet implemented)
  • 8. View Timetabled University Sessions
  • 9. Sync Calendar with Google Maps
  • 10. Estimate Travel Time (not yet implemented)
  • 11. Switch Between City and Building Map
  • 12. Favorite Buildings
• Main Components
  • Interactive Map
  • Timetable/Calendar
  • Building Search
• External Dependencies
• Libraries Part 1
  • 1. Authentication library
  • 2. Authenticator library
  • 3. Building library
  • 3. Building_manager library
  • 4. Buildinginfo library
  • 5. Database library