Skip to content

Product documentation

carlosb6 edited this page Jul 2, 2018 · 7 revisions

The Product

The product is a navigation and information application for the Azrieli College of Engineering Jerusalem, the goal is to help new college students navigate through the campus and find the services they need.

Usage

The product is targeted at new college students.However, it is designed to be used by any visitor. to use the product simply open the program link https://azrieli-maps.firebaseapp.com/ after that just choose the appropriate function that you want.

Features

The main feature for the program is the navigation to the required office. The other features are getting offices' description, and multiple language support.

product architecture

the program will be made according to the SDS page. https://github.com/alkerr/JCE-Indoor-Nav/wiki/SDS

Distribution

the code will be shared among the programmers using git-hub with git, on a branch that has been chosen and known by the programmers.

how to build the program

first you need to open the correct repository on your web browser, and pull the files on git (you can download them manually), then open command line interface on your computer (cmd), and navigate to the files, then serve the program using "ng serve", you can test it locally on you computer by opening "localhost:4200" on your browser.

testing

you can test each component separately or the whole program by building the program as above, and trying out each feature that you want to test.

how to prepare a different version

to make a different version, simply commit the program to a different branch, and link your version with appropriate details and documentation on the main wiki and on the main branch readme.md.

bug report

if you've seen a bug please add an issue and project card on the project board describing the bug and when and where you Encounter it, and include the conditions that led to it, so that it can be replicated in order to know how to fix it, and if possible attach a screen shot of the bug.

pictures

Alt text Alt text Alt text Alt text Alt text Alt text