Skip to content

Commit 6818d55

Browse files
committed
[NEW] First app clean import
1 parent 2e24926 commit 6818d55

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+518
-454
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Intent
2+
3+
This project, `Roback`, is a basic CRUD app whose first goal was to learn the framework Django. It can not be considered as a ready-to-use production app, since key functionnalities are missing. However, it is functional and can be built locally (more info in the dedicated section)
4+
5+
# Vocabulary
6+
7+
- `Roback` : Name of the project
8+
- `Search target` : Name for an entity holding a text in which search can be performed
9+
- `Media` : Name for an entity which holds a piece of media, typically a video or an image
10+
11+
# Features
12+
13+
The main feature is to expose search targets. Each of these search targets holds a main text, and has optional media. There is a basic filtering implementation to perform text search across all search targets. For better performance, search targets access has been paginated.
14+
15+
# Front-end
16+
17+
The exposed data can be viewed in a dedicated UI. The code relative to this frontend can be found [here](https://github.com/LedruRollin/Rofront).
18+
19+
# Ideas of improvement
20+
21+
## Features
22+
- Improve search system, which is currently minimal (a simple check by inclusion)
23+
- Add tag support
24+
- Add media processing : creation of thumbnails, transcoding
25+
26+
## Security
27+
28+
- Add authentification
29+
- Add further safety checks for uploaded files
30+
- Makes the app suitable and safe for production : hide secrets, add automatic error reports, add backup mechanism, add proper CI/CD, etc...
31+
- Write the `pyproject.toml` file to setup build backend and project metadata ([link](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/))
32+
33+
## Quality of life
34+
35+
- Add documentation for exposed routes with a tool like Swagger
36+
- Makes the app easily retrievable and ran locally with a containerization tool like Docker
37+
38+
# Run the project (*WIP section*)
39+
40+
You can retrieve the project via :
41+
42+
```bash
43+
git clone https://github.com/LedruRollin/Roback.git
44+
```

roback/firstapp/formulaire.py

Lines changed: 0 additions & 16 deletions
This file was deleted.

roback/firstapp/models.py

Lines changed: 0 additions & 68 deletions
This file was deleted.

roback/firstapp/serializers.py

Lines changed: 0 additions & 33 deletions
This file was deleted.

roback/firstapp/static/firstapp/styles.css

Lines changed: 0 additions & 3 deletions
This file was deleted.

roback/firstapp/templates/firstapp/add_search_target.html

Lines changed: 0 additions & 14 deletions
This file was deleted.

roback/firstapp/templates/firstapp/base.html

Lines changed: 0 additions & 12 deletions
This file was deleted.

roback/firstapp/templates/firstapp/edit_search_target.html

Lines changed: 0 additions & 13 deletions
This file was deleted.

roback/firstapp/templates/firstapp/search_target_created.html

Lines changed: 0 additions & 9 deletions
This file was deleted.

roback/firstapp/templates/firstapp/search_target_list.html

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)