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
> [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
> [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')),
Andreas Burbach's avatar
update    
Andreas Burbach committed
36
> 
Andreas Burbach's avatar
Andreas Burbach committed
37
> url(r'^accounts/', include('the_social_network.urls.accountUrls')),
Andreas Burbach's avatar
update    
Andreas Burbach committed
38
> 
Andreas Burbach's avatar
Andreas Burbach committed
39
> url(r'^search/', include('the_social_network.urls.searchUrls')),
Andreas Burbach's avatar
update    
Andreas Burbach committed
40
> 
Andreas Burbach's avatar
Andreas Burbach committed
41
42
43
44
45
46
47
48
49
> 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
50
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
51
52
53
54
55
56
57
58

## 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
59
60
61
Register a user  

Requestbody:  
Andreas Burbach's avatar
Andreas Burbach committed
62
```json
Andreas Burbach's avatar
Andreas Burbach committed
63
64
65
66
{  
    "username": "username",  
    "password": "password",  
    "email": "email"  
Andreas Burbach's avatar
Andreas Burbach committed
67
68
} 
``` 
Andreas Burbach's avatar
Andreas Burbach committed
69
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
70
```json
Andreas Burbach's avatar
Andreas Burbach committed
71
72
73
{  
    "token": "token"  
}  
Andreas Burbach's avatar
Andreas Burbach committed
74
```
Andreas Burbach's avatar
Andreas Burbach committed
75
76

##### POST url: ".../authentication/login/"
Andreas Burbach's avatar
Andreas Burbach committed
77
78
79
Login a user  

Requestbody:  
Andreas Burbach's avatar
Andreas Burbach committed
80
```json
Andreas Burbach's avatar
Andreas Burbach committed
81
82
83
84
{  
    "username": "username",  
    "password": "password"  
}  
Andreas Burbach's avatar
Andreas Burbach committed
85
```
Andreas Burbach's avatar
Andreas Burbach committed
86
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
87
```json
Andreas Burbach's avatar
Andreas Burbach committed
88
89
90
{  
    "token": "token"  
}  
Andreas Burbach's avatar
Andreas Burbach committed
91
```
Andreas Burbach's avatar
Andreas Burbach committed
92
93

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

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

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

Andreas Burbach's avatar
Andreas Burbach committed
103
104
105
Requestbody: None  
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
106
107
108

#### Account
##### GET url: ".../accounts/show/<user_id>/"
Andreas Burbach's avatar
Andreas Burbach committed
109
110
111
112
Show a public user  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
113
```json
Andreas Burbach's avatar
Andreas Burbach committed
114
115
116
117
118
119
120
121
122
123
124
125
126
[{  
    "user": {  
        "id": ...,  
        "username": ...,  
        "email": ...,  
        "date_joined": "..."  
    },  
    "image": "...",  
    "biography": "...",  
    "related_by": [],  
    "related_to": [],  
    "statements": []  
}]  
Andreas Burbach's avatar
Andreas Burbach committed
127
```
Andreas Burbach's avatar
Andreas Burbach committed
128
129
130


##### GET url: ".../accounts/show/own/"
Andreas Burbach's avatar
Andreas Burbach committed
131
132
133
134
Show the own user  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
135
```json
Andreas Burbach's avatar
Andreas Burbach committed
136
137
138
139
140
141
142
143
144
145
146
147
148
[{  
    "user": {  
        "id": ...,  
        "username": ...,  
        "email": ...,  
        "date_joined": "..."  
    },  
    "image": "...",  
    "biography": "...",  
    "related_by": [],  
    "related_to": [],  
    "statements": []  
}]  
Andreas Burbach's avatar
Andreas Burbach committed
149
```
Andreas Burbach's avatar
Andreas Burbach committed
150
151

##### GET url: ".../accounts/show/all/"
Andreas Burbach's avatar
Andreas Burbach committed
152
153
154
155
Show all public users  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
156
```json
Andreas Burbach's avatar
Andreas Burbach committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
[{  
    "user": {  
        "id": ...,  
        "username": ...,  
        "email": ...,  
        "date_joined": "..."  
    },  
    "image": "...",  
    "biography": "...",  
    "related_by": [],  
    "related_to": [],  
    "statements": []  
},  
...  
]  
Andreas Burbach's avatar
Andreas Burbach committed
172
```
Andreas Burbach's avatar
Andreas Burbach committed
173
174

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

Andreas Burbach's avatar
Andreas Burbach committed
177
Requestbody:  
Andreas Burbach's avatar
Andreas Burbach committed
178
```json
Andreas Burbach's avatar
Andreas Burbach committed
179
180
181
182
{  
    "biography": "...",  
    "file": "..."  
}  
Andreas Burbach's avatar
Andreas Burbach committed
183
```
Andreas Burbach's avatar
Andreas Burbach committed
184
185
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
186
187

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

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

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

Andreas Burbach's avatar
Andreas Burbach committed
197
198
199
Requestbody: None  
Responsebody: None  
Success: HTTP/200  
Andreas Burbach's avatar
Andreas Burbach committed
200
201

##### PUT url: ".../accounts/operation/add/statement/"
Andreas Burbach's avatar
Andreas Burbach committed
202
203
204
Add a statement to the own account  

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

#### Contents
##### GET url: ".../contents/statements/get/<statement_id>/"
Andreas Burbach's avatar
Andreas Burbach committed
233
234
235
236
Get a statement  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
237
```json
Andreas Burbach's avatar
Andreas Burbach committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
[  
    {  
        "id": ...,  
        "author": {  
            "user": {  
                "id": ...,  
                "username": "..."  
            },  
            "image": "..."  
        },  
        "content": "...",  
        "tagged": [],  
        "mentioned": [],  
        "created": "...",  
        "relation_to_parent": ...,  
        "reactions": []  
    }  
]  
Andreas Burbach's avatar
Andreas Burbach committed
256
```
Andreas Burbach's avatar
Andreas Burbach committed
257
258

##### GET url: ".../contents/statements/with/hashtag/"
Andreas Burbach's avatar
Andreas Burbach committed
259
260
261
262
263
Get all statements with a hashtag  

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

##### GET url: ".../contents/statements/feed/"
Andreas Burbach's avatar
Andreas Burbach committed
287
288
289
290
Get all statements of the accounts that are followed by the user  

Requestbody: None  
Responsebody:  
Andreas Burbach's avatar
Andreas Burbach committed
291
```json
Andreas Burbach's avatar
Andreas Burbach committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
[  
    {  
        "id": ...,  
        "author": {  
            "user": {  
                "id": ...,  
                "username": "..."  
            },  
            "image": "..."  
        },  
        "content": "...",  
        "tagged": [],  
        "mentioned": [],  
        "created": "...",  
        "relation_to_parent": ...,  
        "reactions": []  
    },  
    ...  
]  
Andreas Burbach's avatar
Andreas Burbach committed
311
```
Andreas Burbach's avatar
Andreas Burbach committed
312
313

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

Andreas Burbach's avatar
Andreas Burbach committed
316
317
Requestbody: None  
Reponsebody: ++++++ TODO:  Setting of a hashtag not clear ++++++  
Andreas Burbach's avatar
Andreas Burbach committed
318
319
320
321


#### Search
##### GET url: ".../search/"
Andreas Burbach's avatar
Andreas Burbach committed
322
323
324
325
326
Searchs for a user or hashtag  

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

## Core Database structure

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

1. "the_social_network_account"
Andreas Burbach's avatar
Andreas Burbach committed
354
355
356
357
    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
358
359

2. "the_social_network_statement"
Andreas Burbach's avatar
Andreas Burbach committed
360
361
362
363
364
    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
365
366

3. "the_social_network_accounttagging"
Andreas Burbach's avatar
Andreas Burbach committed
367
368
369
370
371
    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
372
373

4. "the_social_network_hashtag"
Andreas Burbach's avatar
Andreas Burbach committed
374
375
376
377
    with  
    id: int as primary key  
    tag: varchar(30)  
    created: datetime  
Andreas Burbach's avatar
Andreas Burbach committed
378
379

5. "the_social_network_hashtagtagging"
Andreas Burbach's avatar
Andreas Burbach committed
380
381
382
383
384
    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
385
386

6. "the_social_network_reaction"
Andreas Burbach's avatar
Andreas Burbach committed
387
388
389
390
391
392
    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
393
394

7. "the_social_network_relationship"
Andreas Burbach's avatar
Andreas Burbach committed
395
396
397
398
399
    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