README.md 8.23 KB
Newer Older
Andreas Burbach's avatar
Andreas Burbach committed
1
# The Social Network
AndreasBurbach's avatar
AndreasBurbach committed
2

Andreas Burbach's avatar
Andreas Burbach committed
3
The package "The Social Network" is a django base backend core element for any possible social network you can think of. You can easily create clones for all popular social networks. 
AndreasBurbach's avatar
AndreasBurbach committed
4

Andreas Burbach's avatar
Andreas Burbach committed
5
6
## Installation
Minimum requierments are:
AndreasBurbach's avatar
AndreasBurbach committed
7

Andreas Burbach's avatar
Andreas Burbach committed
8
> [Python](https://www.python.org/downloads/) >= 3.9
9
>
Andreas Burbach's avatar
Andreas Burbach committed
10
> [Django](https://pypi.org/project/Django/) >= 3.2.9
11
>
Andreas Burbach's avatar
Andreas Burbach committed
12
> [Pillow](https://pypi.org/project/Pillow/) >= 8.4.0
13
>
Andreas Burbach's avatar
Andreas Burbach committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
> [djangorestframework](https://pypi.org/project/djangorestframework/) >= 3.12.4

Intallation can be done by pip like

> pip install the-social-network

or download manuel on [Pypi](https://pypi.org/project/the-social-network/).

## How to use

If you not have already created a django python project, [create](https://docs.djangoproject.com/en/3.2/intro/tutorial01/) it at first in a new directory with the command

> django-admin startproject mysite

This will create a **mysite** directory in your current directory.

Open the **mysite** directory and open the **settings.py**.
Add *'the_social_network'* to **INSTALLED_APPS** and save the file.

Next open the urls.py and add the following line to your **urlpatterns**

> url(r'^authentication/', include('the_social_network.urls.authenticationUrls')),
> url(r'^accounts/', include('the_social_network.urls.accountUrls')),
> url(r'^search/', include('the_social_network.urls.searchUrls')),
> url(r'^contents/', include('the_social_network.urls.contentUrls'))

Now everything is ready to run django with **the-social-network**.
Create the database with
> python manage.py migrate

and start the server with
> python manage.py runserver

the following page should showup if you open [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser.

## Request API for the URLs

In all requests (except for the request of *authentication/register/* or */authentication/login/*) you need to send the authentification token inside the header.
For authorization use the header name "Authorization" and the value "Token <token>"

#### Authentication
##### POST url: ".../authentication/register/"
Register a user
Requestbody:
{
    "username": "username",
    "password": "password",
    "email": "
}
Responsebody:
{
    "token": "token"
}

##### POST url: ".../authentication/login/"
Login a user
Requestbody:
{
    "username": "username",
    "password": "password"
}
Responsebody:
{
    "token": "token"
}

##### POST url: ".../authentication/logout/"
Logout a user
Requestbody: None
Responsebody: None
Success: HTTP/200

##### GET url: ".../authentication/validate/"
Validate a token
Requestbody: None
Responsebody: None
Success: HTTP/200

#### Account
##### GET url: ".../accounts/show/<user_id>/"
Show a public user
Requestbody: None
Responsebody:
[{
    "user": {
        "id": ...,
        "username": ...,
        "email": ...,
        "date_joined": "..."
    },
    "image": "...",
    "biography": "...",
    "related_by": [],
    "related_to": [],
    "statements": []
}]


##### GET url: ".../accounts/show/own/"
Show the own user
Requestbody: None
Responsebody:
[{
    "user": {
        "id": ...,
        "username": ...,
        "email": ...,
        "date_joined": "..."
    },
    "image": "...",
    "biography": "...",
    "related_by": [],
    "related_to": [],
    "statements": []
}]

##### GET url: ".../accounts/show/all/"
Show all public users
Requestbody: None
Responsebody:
[{
    "user": {
        "id": ...,
        "username": ...,
        "email": ...,
        "date_joined": "..."
    },
    "image": "...",
    "biography": "...",
    "related_by": [],
    "related_to": [],
    "statements": []
},
...
]

##### PUT url: ".../accounts/update/"
Updates the own account. Only "Biography" and "Image" are allowed to be updated.
Requestbody:
{
    "biography": "...",
    "file": "..."
}
Responsebody: None
Success: HTTP/200

##### PUT url: ".../accounts/follow/<user_id>/"
Follow a user
Requestbody: None
Responsebody: None
Success: HTTP/200

##### PUT url: ".../accounts/unfollow/<user_id>/"
Unfollow a user
Requestbody: None
Responsebody: None
Success: HTTP/200

##### PUT url: ".../accounts/operation/add/statement/"
Add a statement to the own account
Requestbody:
{
    "input": "<statement>"
    "reactions": { "to": <reaction_to_a_statement_id>, "relation": <"attack" or "support">}   <--- optional
}
Responsebody:
 {
    "id": ...,
    "author": {
        "user": {
            "id": ...,
            "username": "..."
        },
        "image": "..."
    },
    "content": "...",
    "tagged": [],
    "mentioned": [],
    "created": "...",
    "relation_to_parent": ...
}
Success: HTTP/200

#### Contents
##### GET url: ".../contents/statements/get/<statement_id>/"
Get a statement
Requestbody: None
Responsebody:
[
    {
        "id": ...,
        "author": {
            "user": {
                "id": ...,
                "username": "..."
            },
            "image": "..."
        },
        "content": "...",
        "tagged": [],
        "mentioned": [],
        "created": "...",
        "relation_to_parent": ...,
        "reactions": []
    }
]

##### GET url: ".../contents/statements/with/hashtag/"
Get all statements with a hashtag
Requestbody:None
Queryparameters: "?q=<hashtag>"
Responsebody:
[
    {
        "id": ...,
        "author": {
            "user": {
                "id": ...,
                "username": "..."
            },
            "image": "..."
        },
        "content": "...",
        "tagged": [],
        "mentioned": [],
        "created": "...",
        "relation_to_parent": ...,
        "reactions": []
    },
    ...
]

##### GET url: ".../contents/statements/feed/"
Get all statements of the accounts that are followed by the user
Requestbody: None
Responsebody:
[
    {
        "id": ...,
        "author": {
            "user": {
                "id": ...,
                "username": "..."
            },
            "image": "..."
        },
        "content": "...",
        "tagged": [],
        "mentioned": [],
        "created": "...",
        "relation_to_parent": ...,
        "reactions": []
    },
    ...
]

##### GET url: ".../contents/trending/hashtag/"
Get all trending hashtags which are most used in statements
Requestbody: None
Reponsebody: ++++++ TODO:  Setting of a hashtag not clear ++++++


#### Search
##### GET url: ".../search/"
Searchs for a user or hashtag
Requestbody: None
Queryparameters: "?q=<search_query>&filter=<"user" or "hashtag">"
Responsebody:
{
    "accounts": [
                    {
                    "user": {
                        "id": ...,
                        "username": "...",
                        },
                    "image": "..."
                    },
                    ...
    ],
    "hashtags": [
                    {
                    "id": ...,
                    "tag": "..."
                    },
                    ...
    ]
}

## Core Database structure

The project requieres the base authentication database structure from django and extends it with the following tables:

1. "the_social_network_account"
    with:
    user_id: int as primary key and foreign key to django auth_user
    image: varchar(100)
    biography: varchar(1000)

2. "the_social_network_statement"
    with:
    id: int as primary key
    author_id: int as foreign key to the_social_network_account
    content: varchar(120)
    created: datetime

3. "the_social_network_accounttagging"
    with:
    id: int as primary key
    created: datetime
    account_id: int as foreign key to the_social_network_account
    statement_id: int as foreign key to the_social_network_statement

4. "the_social_network_hashtag"
    with:
    id: int as primary key
    tag: varchar(30)
    created: datetime

5. "the_social_network_hashtagtagging"
    with:
    id: int as primary key
    created: datetime
    hashtag_id: int as foreign key to the_social_network_hashtag
    statement_id: int as foreign key to the_social_network_statement

6. "the_social_network_reaction"
    with:
    id: int as primary key
    created: datetime
    vote: small uint
    child_id: int as foreign key to the_social_network_statement
    parent_id: int as foreign key to the_social_network_statement

7. "the_social_network_relationship"
    with:
    id: int as primary key
    created: datetime
    from_account_id: int as foreign key to the_social_network_account
352
    to_account_id: int as foreign key to the_social_network_account