README.md 8.91 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
9
10
> [Python](https://www.python.org/downloads/) >= 3.9  
> [Django](https://pypi.org/project/Django/) >= 3.2.9  
> [Pillow](https://pypi.org/project/Pillow/) >= 8.4.0  
Andreas Burbach's avatar
Andreas Burbach committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
> [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**

Andreas Burbach's avatar
Andreas Burbach committed
32
33
34
> 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')),  
Andreas Burbach's avatar
Andreas Burbach committed
35
36
37
38
39
40
41
42
43
> 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

Andreas Burbach's avatar
Andreas Burbach committed
44
the default django information page should showup if you open [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser.
Andreas Burbach's avatar
Andreas Burbach committed
45
46
47
48
49
50
51
52

## 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/"
Andreas Burbach's avatar
Andreas Burbach committed
53
54
55
Register a user  

Requestbody:  
Andreas Burbach's avatar
Andreas Burbach committed
56
```json
Andreas Burbach's avatar
Andreas Burbach committed
57
58
59
60
{  
    "username": "username",  
    "password": "password",  
    "email": "email"  
Andreas Burbach's avatar
Andreas Burbach committed
61
62
} 
``` 
Andreas Burbach's avatar
Andreas Burbach committed
63
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
64
```json
Andreas Burbach's avatar
Andreas Burbach committed
65
66
67
{  
    "token": "token"  
}  
Andreas Burbach's avatar
Andreas Burbach committed
68
```
Andreas Burbach's avatar
Andreas Burbach committed
69
70

##### POST url: ".../authentication/login/"
Andreas Burbach's avatar
Andreas Burbach committed
71
72
73
Login a user  

Requestbody:  
Andreas Burbach's avatar
Andreas Burbach committed
74
```json
Andreas Burbach's avatar
Andreas Burbach committed
75
76
77
78
{  
    "username": "username",  
    "password": "password"  
}  
Andreas Burbach's avatar
Andreas Burbach committed
79
```
Andreas Burbach's avatar
Andreas Burbach committed
80
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
81
```json
Andreas Burbach's avatar
Andreas Burbach committed
82
83
84
{  
    "token": "token"  
}  
Andreas Burbach's avatar
Andreas Burbach committed
85
```
Andreas Burbach's avatar
Andreas Burbach committed
86
87

##### POST url: ".../authentication/logout/"
Andreas Burbach's avatar
Andreas Burbach committed
88
Logout a user  
Andreas Burbach's avatar
update    
Andreas Burbach committed
89

Andreas Burbach's avatar
Andreas Burbach committed
90
91
92
Requestbody: None  
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
93
94

##### GET url: ".../authentication/validate/"
Andreas Burbach's avatar
Andreas Burbach committed
95
Validate a token  
Andreas Burbach's avatar
update    
Andreas Burbach committed
96

Andreas Burbach's avatar
Andreas Burbach committed
97
98
99
Requestbody: None  
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
100
101
102

#### Account
##### GET url: ".../accounts/show/<user_id>/"
Andreas Burbach's avatar
Andreas Burbach committed
103
104
105
106
Show a public user  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
107
```json
Andreas Burbach's avatar
Andreas Burbach committed
108
109
110
111
112
113
114
115
116
117
118
119
120
[{  
    "user": {  
        "id": ...,  
        "username": ...,  
        "email": ...,  
        "date_joined": "..."  
    },  
    "image": "...",  
    "biography": "...",  
    "related_by": [],  
    "related_to": [],  
    "statements": []  
}]  
Andreas Burbach's avatar
Andreas Burbach committed
121
```
Andreas Burbach's avatar
Andreas Burbach committed
122
123
124


##### GET url: ".../accounts/show/own/"
Andreas Burbach's avatar
Andreas Burbach committed
125
126
127
128
Show the own user  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
129
```json
Andreas Burbach's avatar
Andreas Burbach committed
130
131
132
133
134
135
136
137
138
139
140
141
142
[{  
    "user": {  
        "id": ...,  
        "username": ...,  
        "email": ...,  
        "date_joined": "..."  
    },  
    "image": "...",  
    "biography": "...",  
    "related_by": [],  
    "related_to": [],  
    "statements": []  
}]  
Andreas Burbach's avatar
Andreas Burbach committed
143
```
Andreas Burbach's avatar
Andreas Burbach committed
144
145

##### GET url: ".../accounts/show/all/"
Andreas Burbach's avatar
Andreas Burbach committed
146
147
148
149
Show all public users  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
150
```json
Andreas Burbach's avatar
Andreas Burbach committed
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
[{  
    "user": {  
        "id": ...,  
        "username": ...,  
        "email": ...,  
        "date_joined": "..."  
    },  
    "image": "...",  
    "biography": "...",  
    "related_by": [],  
    "related_to": [],  
    "statements": []  
},  
...  
]  
Andreas Burbach's avatar
Andreas Burbach committed
166
```
Andreas Burbach's avatar
Andreas Burbach committed
167
168

##### PUT url: ".../accounts/update/"
Andreas Burbach's avatar
Andreas Burbach committed
169
Updates the own account. Only "Biography" and "Image" are allowed to be updated.  
Andreas Burbach's avatar
update    
Andreas Burbach committed
170

Andreas Burbach's avatar
Andreas Burbach committed
171
Requestbody:  
Andreas Burbach's avatar
Andreas Burbach committed
172
```json
Andreas Burbach's avatar
Andreas Burbach committed
173
174
175
176
{  
    "biography": "...",  
    "file": "..."  
}  
Andreas Burbach's avatar
Andreas Burbach committed
177
```
Andreas Burbach's avatar
Andreas Burbach committed
178
179
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
180
181

##### PUT url: ".../accounts/follow/<user_id>/"
Andreas Burbach's avatar
Andreas Burbach committed
182
Follow a user  
Andreas Burbach's avatar
update    
Andreas Burbach committed
183

Andreas Burbach's avatar
Andreas Burbach committed
184
185
186
Requestbody: None  
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
187
188

##### PUT url: ".../accounts/unfollow/<user_id>/"
Andreas Burbach's avatar
Andreas Burbach committed
189
Unfollow a user  
Andreas Burbach's avatar
update    
Andreas Burbach committed
190

Andreas Burbach's avatar
Andreas Burbach committed
191
192
193
Requestbody: None  
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
194
195

##### PUT url: ".../accounts/operation/add/statement/"
Andreas Burbach's avatar
Andreas Burbach committed
196
197
198
Add a statement to the own account  

Requestbody:  
Andreas Burbach's avatar
Andreas Burbach committed
199
```json
Andreas Burbach's avatar
Andreas Burbach committed
200
201
202
203
{  
    "input": "<statement>"  
    "reactions": { "to": <reaction_to_a_statement_id>, "relation": <"attack" or "support">}   <--- optional  
}  
Andreas Burbach's avatar
Andreas Burbach committed
204
```
Andreas Burbach's avatar
Andreas Burbach committed
205
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
206
207
```json
{  
Andreas Burbach's avatar
Andreas Burbach committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    "id": ...,  
    "author": {  
        "user": {  
            "id": ...,  
            "username": "..."  
        },  
        "image": "..."  
    },  
    "content": "...",  
    "tagged": [],  
    "mentioned": [],  
    "created": "...",  
    "relation_to_parent": ...  
}  
Andreas Burbach's avatar
Andreas Burbach committed
222
```
Andreas Burbach's avatar
Andreas Burbach committed
223
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
224
225
226

#### Contents
##### GET url: ".../contents/statements/get/<statement_id>/"
Andreas Burbach's avatar
Andreas Burbach committed
227
228
229
230
Get a statement  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
231
```json
Andreas Burbach's avatar
Andreas Burbach committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
[  
    {  
        "id": ...,  
        "author": {  
            "user": {  
                "id": ...,  
                "username": "..."  
            },  
            "image": "..."  
        },  
        "content": "...",  
        "tagged": [],  
        "mentioned": [],  
        "created": "...",  
        "relation_to_parent": ...,  
        "reactions": []  
    }  
]  
Andreas Burbach's avatar
Andreas Burbach committed
250
```
Andreas Burbach's avatar
Andreas Burbach committed
251
252

##### GET url: ".../contents/statements/with/hashtag/"
Andreas Burbach's avatar
Andreas Burbach committed
253
254
255
256
257
Get all statements with a hashtag  

Requestbody: None  
Queryparameters: "?q=<hashtag>"  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
258
```json
Andreas Burbach's avatar
Andreas Burbach committed
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
[  
    {  
        "id": ...,  
        "author": {  
            "user": {  
                "id": ...,  
                "username": "..."  
            },  
            "image": "..."  
        },  
        "content": "...",  
        "tagged": [],  
        "mentioned": [],  
        "created": "...",  
        "relation_to_parent": ...,  
        "reactions": []  
    },  
    ...  
]  
Andreas Burbach's avatar
Andreas Burbach committed
278
```
Andreas Burbach's avatar
Andreas Burbach committed
279
280

##### GET url: ".../contents/statements/feed/"
Andreas Burbach's avatar
Andreas Burbach committed
281
282
283
284
Get all statements of the accounts that are followed by the user  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
285
```json
Andreas Burbach's avatar
Andreas Burbach committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
[  
    {  
        "id": ...,  
        "author": {  
            "user": {  
                "id": ...,  
                "username": "..."  
            },  
            "image": "..."  
        },  
        "content": "...",  
        "tagged": [],  
        "mentioned": [],  
        "created": "...",  
        "relation_to_parent": ...,  
        "reactions": []  
    },  
    ...  
]  
Andreas Burbach's avatar
Andreas Burbach committed
305
```
Andreas Burbach's avatar
Andreas Burbach committed
306
307

##### GET url: ".../contents/trending/hashtag/"
Andreas Burbach's avatar
Andreas Burbach committed
308
Get all trending hashtags which are most used in statements  
Andreas Burbach's avatar
update    
Andreas Burbach committed
309

Andreas Burbach's avatar
Andreas Burbach committed
310
311
Requestbody: None  
Reponsebody: ++++++ TODO:  Setting of a hashtag not clear ++++++  
Andreas Burbach's avatar
Andreas Burbach committed
312
313
314
315


#### Search
##### GET url: ".../search/"
Andreas Burbach's avatar
Andreas Burbach committed
316
317
318
319
320
Searchs for a user or hashtag  

Requestbody: None  
Queryparameters: "?q=<search_query>&filter=<"user" or "hashtag">"  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
321
```json
Andreas Burbach's avatar
Andreas Burbach committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
{  
    "accounts": [  
                    {  
                    "user": {  
                        "id": ...,  
                        "username": "...",  
                        },  
                    "image": "..."  
                    },  
                    ...  
    ],  
    "hashtags": [  
                    {  
                    "id": ...,  
                    "tag": "..."  
                    },  
                    ...  
    ]  
}  
Andreas Burbach's avatar
Andreas Burbach committed
341
```
Andreas Burbach's avatar
Andreas Burbach committed
342
343
344

## Core Database structure

Andreas Burbach's avatar
Andreas Burbach committed
345
The project requieres the base authentication database structure from django and extends it with the following tables:  
Andreas Burbach's avatar
Andreas Burbach committed
346

Andreas Burbach's avatar
Andreas Burbach committed
347
#### the_social_network_account
Andreas Burbach's avatar
Andreas Burbach committed
348
349
350
351
    with  
    user_id: int as primary key and foreign key to django auth_user  
    image: varchar(100)  
    biography: varchar(1000)  
Andreas Burbach's avatar
Andreas Burbach committed
352

Andreas Burbach's avatar
Andreas Burbach committed
353
#### the_social_network_statement
Andreas Burbach's avatar
Andreas Burbach committed
354
355
356
357
358
    with  
    id: int as primary key  
    author_id: int as foreign key to the_social_network_account  
    content: varchar(120)  
    created: datetime  
Andreas Burbach's avatar
Andreas Burbach committed
359

Andreas Burbach's avatar
Andreas Burbach committed
360
#### the_social_network_accounttagging
Andreas Burbach's avatar
Andreas Burbach committed
361
362
363
364
365
    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  
Andreas Burbach's avatar
Andreas Burbach committed
366

Andreas Burbach's avatar
Andreas Burbach committed
367
#### the_social_network_hashtag
Andreas Burbach's avatar
Andreas Burbach committed
368
369
370
371
    with  
    id: int as primary key  
    tag: varchar(30)  
    created: datetime  
Andreas Burbach's avatar
Andreas Burbach committed
372

Andreas Burbach's avatar
Andreas Burbach committed
373
#### the_social_network_hashtagtagging
Andreas Burbach's avatar
Andreas Burbach committed
374
375
376
377
378
    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  
Andreas Burbach's avatar
Andreas Burbach committed
379

Andreas Burbach's avatar
Andreas Burbach committed
380
#### the_social_network_reaction
Andreas Burbach's avatar
Andreas Burbach committed
381
382
383
384
385
386
    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  
Andreas Burbach's avatar
Andreas Burbach committed
387

Andreas Burbach's avatar
Andreas Burbach committed
388
#### the_social_network_relationship
Andreas Burbach's avatar
Andreas Burbach committed
389
390
391
392
393
    with  
    id: int as primary key  
    created: datetime  
    from_account_id: int as foreign key to the_social_network_account  
    to_account_id: int as foreign key to the_social_network_account