Planning - noamlasry/Choose-Right GitHub Wiki
SDS - Software Design Specification
Introduction Document Goals
According to the use cases and the user stories, we'll build a guideline scheme for our project. This Document will describe the system architecture. The goals of design page are:
- Preparation for the realization of our software.
- Planning the system correctly and efficiently.
- Help us to split the tasks of the implementation between team members.
- Checking correctness of software design.
- find the right Risk table and demands chart.
- Realizing preparation clearly code.
- Focus on the developments we should think about in advance, before we start coding.
Development Method:
Our team works in the Agile method. Any update or change is presented and evaluated by the client. In ideal, the team tries to deliver small releases of the product every two weeks in order to ensure the client full satisfaction.
Development tools:
- Visual Studio Code
- Git, Github
- Angular
- Firebase
- Flamelink
Version control
Git, Github
Product main features
- Homepage - Will contain a link to Google calendar that is synchronized with all the activities and reminders of the association. editing the calendar is possible through the shared Google account.
- Donors page - This page contains all the donors of the association. it is possible to add / delete a donor. any donation is filed under its own donor.
- Team's page - A contact sheet of any staff personal, volunteer and lecturer of the association.
Risk management:
| Risk | Severity | Response |
|---|---|---|
| Lack of time / delays in project progress | Medium | Pre-categorize requirements by importance and conclude with the client on which of them can not be waived |
| Lack of resources | low | Alternative cheap Resources shown in the course |
| Sudden changes from the client side | High | Save spare time and incrace the meeting with the client |
| Lack of communication on the team | Medium | Once a week Face-to-face meeting and fully connection by what up group |
| Unexpected security problem in the system | High | In-depth tests for each change |
Use case:
| Use case | Description |
|---|---|
| Login | Set in the main page of the website, grants access by password to the registered users |
| Calendar (in Home) | The calendar is synced with the entire system and google calendar. will support alerts and group msgs |
| Donors info | This label will use to save the details about the company donors. it will save the history of each one of them. |
| Event info | Synced with the calendar. contains all the details on any special event. |
| Staff info | Details about the current staff - management, volunteers and lecturers. Email, phone, Birth date and management staff notes. |
| Classes info | Shows information and history about classes and courses. Additionally displays the lecturer, school contact person, school name etc. |
Persistence:
We chose a free storage platform in order to satisfy the costumer. Firebase is the app's development and storage platform.
The code is written in Angular Typescript, HTML and CSS.
As a team we found this combination ideal.
Initial Tests
Development Diagram:
Initial architecture:
