ECOM-1FO 1819 Sport L5 SRS - Revision history

Hugo.Gros-D-Aillon at 16:51, 11 December 2018

2018-12-11T16:51:06Z

← Older revision		Revision as of 16:51, 11 December 2018
Line 140:		Line 140:
	'''Side-effects''': None.		'''Side-effects''': None.

	=4. ~~Product~~ ~~evolution~~=		=4. Evolutions possibles=

			Une très bonne base a été développée pour ce projet. L'ensemble des scénario n'ont pas tous été implémentés, pour le futur, il faudra commencer par implémenter ces scénario.
	What must be done to make this project evolve is to make the link between the mobile application and the web application.

	The databases and data models between the two applications are already consistent.
	It will be necessary to be able to send messages (entity) from the mobile application to the web application with the REST API.

	The SOS principle is also already implemented on the web application, all that remains is to make visible all the hikes with at least one SOS for users of the "Emergency" type (not currently implemented).

	=5. Appendices=		=5. Appendices=

	==5.1. SRS structure==		==5.1. SRS structure==
	~~The~~ document is ~~based~~ on ~~template~~ of ~~the~~ Software Requirements Specification ~~(SRS~~) ~~inspired~~ of ~~the~~ IEEE/ANSI 830-1998 ~~Standard~~.		Le document est basé sur le modèle de la spécification SRS (Software Requirements Specification) inspirée de la norme IEEE/ANSI 830-1998.

	'''References:'''		'''References:'''

Hugo.Gros-D-Aillon at 16:48, 11 December 2018

2018-12-11T16:48:50Z

← Older revision		Revision as of 16:48, 11 December 2018
Line 94:		Line 94:
	'''Description''': L'utilisateur remplis un formulaire et entre ses informations de paiement pour s'inscrire à un évènement.		'''Description''': L'utilisateur remplis un formulaire et entre ses informations de paiement pour s'inscrire à un évènement.

			'''Inputs''': Informations à propos de l'utilisateur (préremplis) + informations de paiement
	'''Inputs''': Request of information

	'''Source''': ~~User~~ ~~application (Smart-phone)~~		'''Source''': Application web

	'''Outputs''': ~~Information~~ ~~about~~ ~~users~~ ~~(localization,~~ ~~distress~~ ~~state,~~ ~~ID, post date)~~		'''Outputs''': QR Code correspondant au dossard du participant

	'''Destination''': ~~User application (Smart-phone)~~		'''Destination''': Application web

	'''Action''':		'''Action''':
	* Smart-phone get request (input)
	* REST API		* REST API

	'''Non functional requirements''': None.		'''Non functional requirements''': None.

	'''Pre-condition''': ~~Smartphone~~ Application, ~~Internet~~ ~~connection~~.		'''Pre-condition''': Application web, connexion internet.

	'''Post-condition''': None.		'''Post-condition''': None.
Line 116:		Line 115:


	==3.3 Requirement 3 : ~~Display~~ ~~Hikes~~==		==3.3 Requirement 3 : Scan du dossard==

	'''Function''': ~~Display~~ ~~details~~ of a ~~hike~~ ~~(user~~ ~~localization~~ ~~and~~ ~~hike~~ ~~information)~~.		'''Function''': Met à jour la base de données en fonction des données scannées pendant l'évènement.

			'''Description''': Pendant l'évènement, un bénévole scanne le dossard d'un participant avec son smartphone (et l'application mobile que nous avons développés), cela upload des données sur notre serveur. Ces données contiennent l'utilisateur scanné, l'évènement ainsi que l'heure.
	'''Description''': We will display information of a specific hike and we will also display a map of the itinerary (with real time positions).

	'''Inputs''': ~~User~~ ~~hike~~ ~~and~~ ~~localizations~~		'''Inputs''': QRCode contenant les données

	'''Source''': ~~User~~ ~~(web-site)~~		'''Source''': Application mobile

	'''Outputs''': ~~Information~~ ~~about~~ a ~~specific hike (localization, distress state)~~		'''Outputs''': Données scannées du QRCode

	'''Destination''': ~~User~~ (~~web-site)~~		'''Destination''': Application web (base de données)

	'''Action''':		'''Action''':
			* REST API
	* Connect to an user profile
	* Go on hike page
	* Select a specific hike

	'''Non functional requirements''': None.		'''Non functional requirements''': None.

	'''Pre-condition''': ~~Internet~~ ~~connection~~, ~~user~~ ~~account~~		'''Pre-condition''': Application mobile, connexion internet (3G/4G).

	'''Post-condition''': None.		'''Post-condition''': None.

Hugo.Gros-D-Aillon at 16:38, 11 December 2018

2018-12-11T16:38:06Z

← Older revision		Revision as of 16:38, 11 December 2018
Line 62:		Line 62:


	==3.1 Requirement 1 : ~~Load~~ ~~and~~ ~~store~~ ~~DATA~~==		==3.1 Requirement 1 : Création d'un évènement sportif==

	'''Function''': ~~Take~~ ~~data~~ ~~(user~~ ~~localization and distress state) via HTTP (REST API)~~.		'''Function''': Création d'un évènement sportif.

			'''Description''': Remplissage d'un formulaire par l'organisateur d'un évènemenent pour le créer. Contient différents champs comme le prix, le lieu (qui sera transformé automatiquement en longitude et latitude), la description, le nom, etc.
	'''Description''': We will collect information from users (Smart-phone application -> Server) through REST API.

			'''Inputs''': Informations sur l'évènement : Organisateur, Titre, Description, Sport, Date, Heure, Longitude, Latitude, Lieu, Prix, Image 1, Image 2, Image 3, Image 4, Image 5, Participants
	'''Inputs''': Information about the user (localization, distress state, ID, post date)

	'''Source''': ~~User~~ ~~application (Smart-phone)~~		'''Source''': Application web

	'''Outputs''': ~~Data~~ ~~stored~~ in ~~the~~ ~~server~~ DB		'''Outputs''': L'évènement qui à bien été créé dans la base de données.

	'''Destination''': ~~Server~~		'''Destination''': Serveur

	'''Action''':		'''Action''':
			* REST API - MAJ de la base de données
	* Smart-phone post request (input)
	* REST API - update the DB

	'''Non functional requirements''': None.		'''Non functional requirements''': None.

	'''Pre-condition''': ~~Smartphone~~ Application, ~~Internet~~ ~~connection~~.		'''Pre-condition''': Application web, connexion internet.

	'''Post-condition''': None.		'''Post-condition''': None.
Line 89:		Line 88:


	==3.2 Requirement 2 : ~~Send~~ ~~DATA~~==		==3.2 Requirement 2 : Inscription à un évènement sportif==

	'''Function''': ~~Send~~ ~~data~~ ~~(user~~ ~~localization~~ ~~and~~ ~~distress~~ ~~state)~~ ~~via HTTP~~ (~~REST~~ ~~API)~~ to ~~every~~ ~~hikers~~ ~~of the hike.~~		'''Function''': Ajout d'un utilisateur dans les participants d'une course (MAJ de la base de données)

			'''Description''': L'utilisateur remplis un formulaire et entre ses informations de paiement pour s'inscrire à un évènement.
	'''Description''': We will send information (if necessary) to any hikers (who are in the same hike) (Server -> Smart-phone application ) through REST API.

	'''Inputs''': Request of information		'''Inputs''': Request of information

Hugo.Gros-D-Aillon at 10:59, 11 December 2018

2018-12-11T10:59:31Z

← Older revision		Revision as of 10:59, 11 December 2018
Line 54:		Line 54:
	Pour ce projet, nous utilisons la librairie de gestion de cartes [https://leafletjs.com/ Leaflet] ainsi qu'une API permettant de transformer un lieu (en string) en coordonnées (lon, lat) : [https://adresse.data.gouv.fr/api API]		Pour ce projet, nous utilisons la librairie de gestion de cartes [https://leafletjs.com/ Leaflet] ainsi qu'une API permettant de transformer un lieu (en string) en coordonnées (lon, lat) : [https://adresse.data.gouv.fr/api API]

			=3.Exigences spécifiques, couvrant les exigences fonctionnelles, non fonctionnelles et d'interface=
	=3.Specific requirements, covering functional, non-functional and interface requirements=
	* ~~document~~ ~~external~~ interfaces,		* Documenter les interfaces externes,
	* ~~describe~~ ~~system~~ ~~functionality~~ ~~and~~ performance		* décrire la fonctionnalité et la performance du système
			* spécifier les exigences de la base de données logique,
	* specify logical database requirements,
			* contraintes de conception,
	* design constraints,
			* les propriétés du système émergent et les caractéristiques de qualité.
	* emergent system properties and quality characteristics.

Hugo.Gros-D-Aillon at 10:56, 11 December 2018

2018-12-11T10:56:59Z

← Older revision		Revision as of 10:56, 11 December 2018
Line 52:		Line 52:

	==2.5 Dépendances==		==2.5 Dépendances==
	Pour ce projet, nous utilisons la librairie de gestion de cartes Leaflet ainsi qu'une API permettant de transformer un lieu (en string) en coordonnées (lon, lat) : [https://adresse.data.gouv.fr/api]		Pour ce projet, nous utilisons la librairie de gestion de cartes [https://leafletjs.com/ Leaflet] ainsi qu'une API permettant de transformer un lieu (en string) en coordonnées (lon, lat) : [https://adresse.data.gouv.fr/api API]

	=3.Specific requirements, covering functional, non-functional and interface requirements=		=3.Specific requirements, covering functional, non-functional and interface requirements=

Hugo.Gros-D-Aillon at 10:56, 11 December 2018

2018-12-11T10:56:03Z

← Older revision		Revision as of 10:56, 11 December 2018
Line 46:		Line 46:


	==2.4 ~~General constraints~~==		==2.4 Contraintes==
			Pour s'inscrire à un évènement, les utilisteurs devront s'être inscrits sur l'application web.
	To visualize the hike, the user will have to use an external application developed by our colleagues.
	An Internet connection will be necessary to upload data from the application to the server.
	(Not necessarily at any time of the hike)

			Nous ne différencions pas les différents types d'utilisateurs dans ce projet. Tout le monde peut être un organisateur et/ou un coureur et/ou un bénévole.
	==2.5 Assumptions and dependencies==

	This project fully depends on [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] project to collect data.
			==2.5 Dépendances==
			Pour ce projet, nous utilisons la librairie de gestion de cartes Leaflet ainsi qu'une API permettant de transformer un lieu (en string) en coordonnées (lon, lat) : [https://adresse.data.gouv.fr/api]

	=3.Specific requirements, covering functional, non-functional and interface requirements=		=3.Specific requirements, covering functional, non-functional and interface requirements=

Hugo.Gros-D-Aillon at 10:51, 11 December 2018

2018-12-11T10:51:06Z

@@ Line 16: / Line 16: @@
 *Page principale du projet: [https://air.imag.fr/index.php/ECOM-1FO_1819_Sport]
-=2.   General description=
+=2.   Description générale=
-==2.1   Product perspective==
+==2.1   Perspectives du projet==
-Our Web site is an open source project.
+Ce projet est un projet open source.
-==2.2   Product functions==
+==2.2   Fonctionnalités==
 ==2.4   General constraints==

Hugo.Gros-D-Aillon at 10:35, 11 December 2018

2018-12-11T10:35:39Z

@@ Line 1: / Line 1: @@
 =1.   Introduction=
-==1.1   Purpose of the requirements document==
+==1.1   But du document==
-This Software Requirements Specification (SRS) identifies the requirements for project [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeam_7.1 UltraTeam 7.1]
+Cette spécification des exigences logicielles (SRS) identifie les exigences du projet [https://air.imag.fr/index.php/ECOM-1FO_1819_Sport].
-This document is a guideline about the functionalities offered and the problems that the system solves.
+Ce document est un guide sur les fonctionnalités offertes et les problèmes que le système résout.
-==1.3   Definitions, acronyms and abbreviations==
+==1.2   Visée du projet==
 =2.   General description=

Hugo.Gros-D-Aillon: Created page with "The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard. '''Read first:''' * http://www.cs.st-an..."

2018-12-11T10:06:07Z

Created page with "The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard. '''Read first:''' * http://www.cs.st-an..."

New page

The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.

'''Read first:'''
* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
* http://en.wikipedia.org/wiki/Software_requirements_specification
* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]

{|class="wikitable alternance"
|+ Document History
|-
|
!scope="col"| Version
!scope="col"| Date
!scope="col"| Authors
!scope="col"| Description
!scope="col"| Validator
!scope="col"| Validation Date
|-
!scope="row" |
| 0.1.0
| TBC
| TBC
| TBC
| TBC
| TBC

|}

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for project [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeam_7.1 UltraTeam 7.1]
This document is a guideline about the functionalities offered and the problems that the system solves.

==1.2 Scope of the product==
The aim of this project is to create a Web Site with these specifications :
* Collect data from the web application [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV]
* Synchronize data between server and clients
* Data visualization (from [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] hikes)

This project may allow hikers to visualize their hikes.

It will also permit the synchronization of positions during the hike.

==1.3 Definitions, acronyms and abbreviations==
DB = Data Base

GPS = Global Positionning System

==1.4 References==
*The main page of the project: [http://air.imag.fr/index.php/UltraTeam UltraTeam]
*The page of our contribution [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeam_7.1 UltraTeam_7.1]
*[https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeam_7.1/UML UML] diagrams

==1.5 Overview of the remainder of the document==

=2. General description=
==2.1 Product perspective==
Our Web site is an open source project.

This site will store and display data (GPS localisation from [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] users ).

==2.2 Product functions==
*Centralization and synchronization of data.
*Data visualization.

==2.3 User characteristics==
The typical user is a hiker who did a hike using [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] application.
The user doesn't need specific or technical knowledge, just a basic Internet usage.

==2.4 General constraints==
To visualize the hike, the user will have to use an external application developed by our colleagues.
An Internet connection will be necessary to upload data from the application to the server.
(Not necessarily at any time of the hike)

==2.5 Assumptions and dependencies==
This project fully depends on [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] project to collect data.

=3.Specific requirements, covering functional, non-functional and interface requirements=
* document external interfaces,
* describe system functionality and performance
* specify logical database requirements,
* design constraints,
* emergent system properties and quality characteristics.

==3.1 Requirement 1 : Load and store DATA==

'''Function''': Take data (user localization and distress state) via HTTP (REST API).

'''Description''': We will collect information from users (Smart-phone application -> Server) through REST API.

'''Inputs''': Information about the user (localization, distress state, ID, post date)

'''Source''': User application (Smart-phone)

'''Outputs''': Data stored in the server DB

'''Destination''': Server

'''Action''':
* Smart-phone post request (input)
* REST API - update the DB

'''Non functional requirements''': None.

'''Pre-condition''': Smartphone Application, Internet connection.

'''Post-condition''': None.

'''Side-effects''': None.

==3.2 Requirement 2 : Send DATA==

'''Function''': Send data (user localization and distress state) via HTTP (REST API) to every hikers of the hike.

'''Description''': We will send information (if necessary) to any hikers (who are in the same hike) (Server -> Smart-phone application ) through REST API.

'''Inputs''': Request of information

'''Source''': User application (Smart-phone)

'''Outputs''': Information about users (localization, distress state, ID, post date)

'''Destination''': User application (Smart-phone)

'''Action''':
* Smart-phone get request (input)
* REST API

'''Non functional requirements''': None.

'''Pre-condition''': Smartphone Application, Internet connection.

'''Post-condition''': None.

'''Side-effects''': None.

==3.3 Requirement 3 : Display Hikes==

'''Function''': Display details of a hike (user localization and hike information).

'''Description''': We will display information of a specific hike and we will also display a map of the itinerary (with real time positions).

'''Inputs''': User hike and localizations

'''Source''': User (web-site)

'''Outputs''': Information about a specific hike (localization, distress state)

'''Destination''': User (web-site)

'''Action''':
* Connect to an user profile
* Go on hike page
* Select a specific hike

'''Non functional requirements''': None.

'''Pre-condition''': Internet connection, user account

'''Post-condition''': None.

'''Side-effects''': None.

=4. Product evolution=

What must be done to make this project evolve is to make the link between the mobile application and the web application.

The databases and data models between the two applications are already consistent.
It will be necessary to be able to send messages (entity) from the mobile application to the web application with the REST API.

The SOS principle is also already implemented on the web application, all that remains is to make visible all the hikes with at least one SOS for users of the "Emergency" type (not currently implemented).

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
* http://en.wikipedia.org/wiki/Software_requirements_specification
* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]

=6. Index=