ECOM-1FO 1819 mycamping L5 SRS

=1.  Introduction=

1.1 Purpose of the requirements document
This Software Requirements Specification (SRS) identifies the requirements for project MyCamping.

In case of a open source project, we must present the requirement to others potential contributors. This document is a guideline about the functionalities offered and the problems that the system solves.

1.2 Scope of the product
This software is an e-commerce application.

It is meant to be deployed online.

1.4 References

 * The main page of the project: ECOM-1FO_1819_Camping

1.5 Overview of the remainder of the document
=2.  General description=

2.1 Product perspective
This software is an e-commerce application generated with JHipster. The goal is to deploy the application online to allow users to search for a campsite and rent it. It also allows users to create a new offer that will be displayed on the webstie and that can be rented by others.

2.2 Product functions

 * Searching for a campsite with different filters (date, utilities, price, etc).
 * Renting a campsite.
 * Having an account on which you can consult your current rents.
 * Having an account on which you can create an offer for a campsite.
 * Paying with credit card or paypal and recieving the invoice by email.

2.3 User characteristics
The user need to know how to use a computer.

2.4 General constraints
An internet connection is needed to connect to the website.

2.5 Assumptions and dependencies
As the application is cool generated with JHipster, the application has the dependencies the JHipster has.

It needs npm to allow the angular project to run.

It needs a running mysql database conected to the project.

=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
Function:

Searching for a campsite with different filters (date, utilities, price, etc).

Description:

On the main page of the website, a campsite list is displayed, filtered by dates, utilities, price, location, depending on what the user wants.

Inputs:

Filters are selected by the user in a form.

Source:

The user.

Outputs:

A campsite list matching the selected filters.

Destination:

The list displays on the homepage.

Non functional requirements:

The server on which the website is must be online and responding.

Pre-condition:

The user needs to be on the homepage to fill the form.

3.2 Requirement 2
Function:

Rent a campsite.

Description:

Allows the user to be able to rent a campsite.

Inputs:

Mouse clicks.

Source:

The user.

Outputs:

The payment page.

Destination:

The screen.

Non functional requirements:

The server on which the website is must be online and responding.

Pre-condition:

The user needs to be on a campsite offer.

3.3 Requirement 3
Function:

Having an account on which you can consult your current rents

Description:

The logged user has access to a page where he can check the the information of his current rent.

Inputs:

Mouse clicks.

Source:

The user.

Outputs:

The reservation page.

Destination:

The screen.

Non functional requirements:

The server on which the website is must be online and responding.

Pre-condition:

The user must be logged in. The user must have rented a campsite.

3.4 Requirement 4
Function:

Having an account on which you can create an offer for a campsite.

Description:

Allows a user to create a new campsite offer, by completing the needed information.

Inputs:

Informations filled by the user in a form.

Source:

The user.

Outputs:

A new campsite offer.

Destination:

The database and thus thus the website.

Non functional requirements:

The server on which the website is must be online and responding.

Pre-condition:

The user needs to be logged in.

3.5 Requirement 5


Function:

Paying with credit card or paypal.

Description:

Allows the user to fullfil the rent by paying, either with a credit card or with paypal.

Inputs:

The paying informations in a form.

Source:

The user.

Outputs:

The invoice.

Destination:

The mailbox of the user.

Non functional requirements:

The server on which the website is must be online and responding.

Pre-condition:

The email adress of the user must be valid.

=4. Product evolution=

=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
 * IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998

=6. Index=