https://github.com/marouenes/smart-sms
Driving Brands through Creative Influence
https://github.com/marouenes/smart-sms
branding content-management hackathon social-media telecommunications
Last synced: 6 months ago
JSON representation
Driving Brands through Creative Influence
- Host: GitHub
- URL: https://github.com/marouenes/smart-sms
- Owner: marouenes
- License: mit
- Created: 2023-11-24T17:35:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-26T08:32:01.000Z (over 2 years ago)
- Last Synced: 2023-11-26T11:22:07.630Z (over 2 years ago)
- Topics: branding, content-management, hackathon, social-media, telecommunications
- Language: Makefile
- Homepage:
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SmartSMS © TakeOff
[](https://github.com/marouenes/creator-io/blob/main/LICENSE)
[](https://github.com/marouenes/creator-io/blob/main/CONTRIBUTING.md)
## Table of Contents
- [Introduction](#introduction)
- [Product Overview](#product-overview)
- [Problem Statement](#problem-statement)
- [Solution](#solution)
- [Functional Requirements](#functional-requirements)
- [Non-Functional Requirements](#non-functional-requirements)
- [Architectural Decisions and Background](#architectural-decisions-and-background)
- [Software Components](#software-components)
- [System Requirements](#system-requirements)
- [Timeline](#timeline)
- [Development Workflow](#development-workflow)
- [Context Diagrams](#context-diagrams)
- [Release Notes](#release-notes)
- [Contributing](#contributing)
- [References](#references)
- [License](#license)
## Introduction
### Product Overview
This repository contains the an overview of the product and the development process.
Here is the initial mockup of the desktop application: [Desktop Application Mockup](https://shorturl.at/BGX89)
## Problem Statement
The problem statement explain the constraints that provided the significant influence over the architecture.
## Solution
### Product Objectives
The objective key results (OKRs) of the product.
#### Functional Requirements
- [ ] FR1: The system shall be able to ...
- [ ] FR2: The system shall be able to ...
#### Non-Functional Requirements
- [ ] The software ecosystem should be easy to use.
- [ ] The software ecosystem should be easy to maintain.
## Architectural decisions and background
The architectural decisions and background explain the decisions that were made during the development process.
## Software Components
The software ecosystem of the product is composed of the following components:
- Frontend components and elements (UI/UX)
- Backend (REST API)
- Anayltics (Streaming applicaiton)
- Datamart (Data Model)
## System Requirements
This section describes the general function and purpose for the system or subsystem whose architecture is described in this SWAD.
## Timeline
The timeline of the project. The timeline is a list of the major milestones and the dates they are expected to be completed.
## Development workflow
The development workflow describes the development process of the product. The development process is composed of the following steps:
- [ ] Step 1: ...
- [ ] Step 2: ...
- [ ] Step 3: ...
## Context Diagrams
This section describes the goals and major contextual factors for the software architecture.
The section includes a description of the role software architecture plays in the life cycle, the relationship to system engineering results and artifacts, and any other relevant factors.
## Release Notes
The release notes describe the changes made in each release. The release notes are composed of the following sections:
- [ ] Release 1.0.0
- [ ] FR1: The system shall be able to ...
- [ ] FR2: The system shall be able to ...
## Contributing
Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
## References
- [Software Design](https://en.wikipedia.org/wiki/Software_architecture_document)
- [Software Architecture Document](docs/pdf/SWAD.pdf)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details