add basic documentation for login app #1895 #1363

jh-RLI · jh-RLI · commit 33d8dc762463 · 2024-11-20T19:35:12.000+01:00
diff --git a/docs/oeplatform-code/apps/index.md b/docs/oeplatform-code/apps/index.md
@@ -0,0 +1,3 @@
+# oeplatform django apps
+
+In this section we document the oeplatform applications. As we not yet migrated the architecture to a more commonly used one we maintain all apps in the root django project directory. This impacts how we apply settings as configuration to the whole system. Each App implements a specific group of features to provide solutions to certain user needs. We implement the apps to provide very specific tool to all users and encourage them to upload and document their data. This approach reflects our vision to continually publish our research work results as publicly usable functionality. This requirement we set ourself often brings a lot of extra effort as usability must also be prioritized. This correctly suggests that each app also maintains a user interface and possibly also some app specific data is stored in the django database.
diff --git a/docs/oeplatform-code/apps/login.md b/docs/oeplatform-code/apps/login.md
@@ -0,0 +1,11 @@
+# Login
+
+This app handles the user authentication using django allauth and implements a user profile that provide an overview on tables and helps to manage the datasets draft or published state. Additionally the profile pages include the permission groups to manage data table resource access permissions as group with other users. The last feature is the user profile, including a view showing the api token with functionality to reset it as well as a Form to provide additional user data like adding a user image.
+
+## App Components
+
+The components of each app implement the django app structure and implement a MVVM pattern for web applications. This includes the files model.py, views.py, urls.py,  Then there are migrations that specify the django table structure and is also a core django feature. The templates include all HTML page payouts including django template syntax to render pages with dynamic server data and JavaScript. Additionally there might be other folders and python modules available.w
+
+### Views
+
+::: login.views

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# oeplatform django apps`
	`2`	`+`
	`3`	+In this section we document the oeplatform applications. As we not yet migrated the architecture to a more commonly used one we maintain all apps in the root django project directory. This impacts how we apply settings as configuration to the whole system. Each App implements a specific group of features to provide solutions to certain user needs. We implement the apps to provide very specific tool to all users and encourage them to upload and document their data. This approach reflects our vision to continually publish our research work results as publicly usable functionality. This requirement we set ourself often brings a lot of extra effort as usability must also be prioritized. This correctly suggests that each app also maintains a user interface and possibly also some app specific data is stored in the django database.