Skip to content
This repository has been archived by the owner on Aug 23, 2021. It is now read-only.

Latest commit

 

History

History
227 lines (137 loc) · 7.34 KB

File metadata and controls

227 lines (137 loc) · 7.34 KB

Ceangal-Messenger -- Software Requirements Specification

1. Introduction

1.1 Purpose

This Software Requirements Specification (SRS) describes all specifications for the application "Ceangal Messenger". The project is a little social chat app with self deployable servers, it should prevent your data to be stored by other companys.

1.2 Scope

The project is going to be realized as a Desktop Application. Some functions are:

  • Add friends
  • Personal user profile
  • Chat with friends

1.3 Definitions, Acronyms and Abbreviations

Term
SRS Software Requirements Specification
n/a Not Applicable
TBD To Be Determined

1.4 References

Title Date
Blog 15/10/2020
GitHub --Code 15/10/2020
GitHub --Documentation 15/10/2020
Use Case Diagram 15/10/2020

1.5 Overview

The following chapter is an overview about this project. Chapter number three is about the specific requirements and goes more in detail. At the end are the supporting informations.

2. Overall Description

2.1 Vision

Ceangal Messenger is a little social chat app with self deployable servers. Every user has a profile with personal information. You should be able to add friends and write with them in a private text Channel. Later on we want to implement self deployable servers with voice and text channels.

2.2 Use Case Diagram

Use Case Diagram

2.3 Technology Stack

  • Kotlin
  • Electron and ExpressJs/NodeJs
  • Bootstrap
  • Spring Boot and Spring Data JPA
  • MariaDB adn H2 DB

3. Specific Requirements

3.1 Functionality

In this section you can see our different use cases.

3.1.1 Use Cases

3.1.1.1 Add Friend

You can find the use case here

3.1.1.2 Create Text Channel

You can find the use case here

3.1.1.3 Create User Profile

You can find the use case here

3.1.1.4 Edit User Profile

You can find the use case here

3.1.1.5 Delete Account

You can find the use case here

3.1.1.6 Edit Text Channel

You can find the use case here

3.1.1.7 Send friend private message

You can find the use case here

3.1.1.8 Show friends

You can find the use case here

3.2 Usability

The app should be easy to understand and be minimalistic.

3.3 Reliability

The backend should be available any time.

3.4 Performance

It should run on every desktop device and have short loading times.

3.5 Supportability

You can easily start your own backend server. It depends on you if the service is available or not.

3.6 Design Constraints

It should be minimalistic and lightweight.

3.7 Online User Documentation and Help System Requirements

You can find out Doku here GitHub Documentation

3.8 Purchased Components

We only use open-source software so nothing is purchased

3.9 Interfaces

3.9.1 User Interfaces

The interaction with the user is provided through the Electron application.

3.9.2 Hardware Interfaces

(n/a)

3.9.3 Software Interfaces

We want to use a REST API to communicate between client and backend server.

3.9.4 Communications Interfaces

(n/a)

3.10 Licensing Requirements

(n/a)

3.11 Legal, Copyright and other Notices

The logo is licensed to the Ceangal Messenger Team. We do not take responsibilty for any incorrect data or errors in the application.

3.12 Applicable Standards

We will follow the standard code conventions for JavaScript and Kotlin.

4. Supporting Information

For more information look into our blog