Skip to content

Commit

Permalink
Update lvl 1
Browse files Browse the repository at this point in the history
  • Loading branch information
43D committed Nov 28, 2023
1 parent 826faa5 commit 58ef794
Show file tree
Hide file tree
Showing 16 changed files with 125 additions and 123 deletions.
2 changes: 1 addition & 1 deletion .c4builder
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"charset": "UTF-8",
"hasRun": true,
"checksums": [
"ab8f0dbc28b2d93a241302aba141fdae1388aa5fa8f76da8929daa6c45c6199c",
"eff025a09817785485a7c3cd9c62fb1dbd79c5682e01e362ca2cc0ea1942d5b4",
"a2eedf6c5abeeca7f8b53f0cd9cb65eaac03604ec92ef3ac629236029f969237",
"3837a4607372c49d01edf97f7b326201ed285e5f892c9c92e464f50088d9923a",
"8250c7ad340f312f4f0cd143d02fec9f91d485ac2fa2f723632d3eb054ff7f05",
Expand Down
66 changes: 10 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,18 @@
# PySocial

# Introduction
# SwiftSend

This project was created using [c4builder](https://adrianvlupu.github.io/C4-Builder/)
**Acesso a documentação:**
[Acesse aqui](https://43d.github.io/tcc-utfpr-2024/#/)

Take a look at
<hr>

- [PlantUml](http://plantuml.com/) creates diagrams from plain text.

- [Markdown](https://guides.github.com/features/mastering-markdown/) creates rich text documents from plant text.

- [C4Model](https://c4model.com/) the idea behind maps of your code

- [C4-PlantUML](https://github.com/RicardoNiepel/C4-PlantUML) C4 syntax support for generating plantuml diagrams

- [vscode-plantuml](https://github.com/qjebbs/vscode-plantuml) plugin for visual studio code to view diagrams at design time

Open the terminal and run the following commands to start compiling the documentation
Requisitos:
* Node.js

```bash
npm i -g c4builder
c4builder
```

> Note on using local images inside markdown files
>
> Images should be placed next to the markdown file using them.
>
> All of them will be copied over to the `docs` folder either in `/` (in the case of a single MD/PDF file) or following the same folder structure as in `src`, so make sure they have unique names.
# Abstractions used

![C4Model](https://c4model.com/img/abstractions.png)

### Person

However you think about your users (as actors, roles, personas, etc), people are the various human users of your software system.

### Software System

A software system is the highest level of abstraction and describes something that delivers value to its users, whether they are human or not. This includes the software system you are modelling, and the other software systems upon which your software system depends (or vice versa).

### Container

A container represents something that hosts code or data. A container is something that needs to be running in order for the overall software system to work. In real terms, a container is something like:

- Server-side web application: A Java EE web application running on Apache Tomcat, an ASP.NET MVC application running on Microsoft IIS, a Ruby on Rails application running on WEBrick, a Node.js application, etc.

- Client-side web application: A JavaScript application running in a web browser using Angular, Backbone.JS, jQuery, etc).

- Client-side desktop application: A Windows desktop application written using WPF, an OS X desktop application written using Objective-C, a cross-platform desktop application written using JavaFX, etc.
- Mobile app: An Apple iOS app, an Android app, a Microsoft Windows Phone app, etc.

- Server-side console application: A standalone (e.g. "public static void main")

- etc

### Component

Component
The word "component" is a hugely overloaded term in the software development industry, but in this context a component is simply a grouping of related functionality encapsulated behind a well-defined interface. If you're using a language like Java or C#, the simplest way to think of a component is that it's a collection of implementation classes behind an interface. Aspects such as how those components are packaged (e.g. one component vs many components per JAR file, DLL, shared library, etc) is a separate and orthogonal concern.

An important point to note here is that all components inside a container typically execute in the same process space.
git clone https://github.com/43D/SwitfSend_C4Builder.git
cd .\SwitfSend_C4Builder\
c4builder site
```
Binary file modified docs/1 Internet Banking System/1 Internet Banking System.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/2 Deployment/2 Deployment.pdf
Binary file not shown.
23 changes: 15 additions & 8 deletions docs/HOME.md

Large diffs are not rendered by default.

Binary file modified docs/PySocial Project.pdf
Binary file not shown.
23 changes: 15 additions & 8 deletions docs/PySocial.md

Large diffs are not rendered by default.

Binary file modified docs/PySocial.pdf
Binary file not shown.
23 changes: 15 additions & 8 deletions docs/README.md

Large diffs are not rendered by default.

69 changes: 42 additions & 27 deletions docs/context.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 14 additions & 7 deletions src/context.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
**Level 1: System Context diagram**
**Level 1: Diagrama de contexto do PySocial**

A System Context diagram is a good starting point for diagramming and documenting a software system, allowing you to step back and see the big picture. Draw a diagram showing your system as a box in the centre, surrounded by its users and the other systems that it interacts with.
**Scope**: PySocial é um sistema que permite autenticar nas plataformas de redes sociais e gerenciar seus conteúdos digitais de forma cruzada.

Detail isn't important here as this is your zoomed out view showing a big picture of the system landscape. The focus should be on people (actors, roles, personas, etc) and software systems rather than technologies, protocols and other low-level details. It's the sort of diagram that you could show to non-technical people.
**Elementos primários**:
* Usuário
* PySocial System

**Scope**: A single software system.
<br>

**Primary elements**: The software system in scope.
Supporting elements: People (e.g. users, actors, roles, or personas) and software systems (external dependencies) that are directly connected to the software system in scope. Typically these other software systems sit outside the scope or boundary of your own software system, and you don’t have responsibility or ownership of them.
**Elementos de suporte**:
* Facebook API
* Instagram API
* X (Twiiter) API
* TikTok API
* YouTube API

**Intended audience**: Everybody, both technical and non-technical people, inside and outside of the software development team.

**Público-alvo**: Todos, técnicos e não técnicos, dentro e fora da equipe de desenvolvimento de software.
21 changes: 13 additions & 8 deletions src/context.puml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@

LAYOUT_WITH_LEGEND()

Person(pbc, "Personal Banking Customer", "A customer of the bank, with personal bank accounts.")
System(ibs, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
System_Ext(es, "E-mail system", "The internal Microsoft Exchange e-mail system.")
System_Ext(mbs, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
Person(user, "Usuário", "Um usuário que possue a necessidade de enviar o mesmo conteúdo para várias redes sociais.")
System(pys, "PySocial System", "Sistema cliente que gerencia contas de redes sociais e seus conteúdos digitais.")
System_Ext(face, "Facebook API", "Interface de comunicação com rede social Facebook.")
System_Ext(inst, "Instagram API", "Interface de comunicação com rede social Instagram.")
System_Ext(x, "X (Twiiter) API", "Interface de comunicação com rede social X.")
System_Ext(tt, "TikTok API", "Interface de comunicação com rede social TikTok.")
System_Ext(yt, "YouTube API", "Interface de comunicação com rede social YouTube.")

Rel(pbc, ibs, "Uses")
Rel(es, pbc, "Sends e-mails to")
Rel(ibs, es, "Sends e-mails", "SMTP")
Rel(ibs, mbs, "Uses")
Rel(user, pys, "interage com")
Rel(pys, face, "intrega a")
Rel(pys, inst, "intrega a")
Rel(pys, x, "intrega a")
Rel(pys, tt, "intrega a")
Rel(pys, yt, "intrega a")
@enduml

0 comments on commit 58ef794

Please sign in to comment.