You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@
4
4
5
5
This is a university project for teaching object-oriented programming at UniMoRe university (a.y. 2022/2023).
6
6
7
-
8
7
-[Taskup](#taskup)
9
8
*[Get Started](#get-started)
10
9
+[Dependencies](#dependencies)
@@ -72,6 +71,8 @@ After dependencies installation, this app can be opened using `main.py`.
72
71
73
72
`main.py` accepts some parameters based on execution modality.
74
73
74
+
If desired, you can create a working executable all-in-one by downloading PyInstaller and running the following command: `python3 -m eel main.py frontend/ --onefile`.
75
+
75
76
#### Modality
76
77
77
78
-`run`, `r` or _nothing_: launch the application
@@ -89,6 +90,7 @@ It is possible to manage application settings using `settings.json`, this file h
89
90
Inserting custom settings in it, they override base default settings (managed by `SettingsManager`).
90
91
91
92
The settings available are:
93
+
92
94
-`vault_path`, a string that contains the path of directory in which will be saved the file which stores user's credentials
93
95
-`current_project_path`, a string which contains the project path which will be loaded at the beginning
94
96
-`projects_stored_paths`, a list of strings which contains the paths of already opened projects
@@ -106,6 +108,7 @@ The settings available are:
106
108
-`edge` to open app in Edge browser
107
109
108
110
## Contribute
111
+
109
112
Everyone can contribute to this project.
110
113
111
114
Contributing is possible via pull request. You can develop something present in the [TODO](TODO.md) file or new feature from scratch.
@@ -212,12 +215,15 @@ For example, the _Manage Task Label_ page looks like this:
212
215
In addition, if there are a lot of resources, it is possible to use filters.
213
216
214
217
## Home
218
+
215
219
**Home page** provides a set of sections where is possible:
220
+
216
221
- Watch _project information_
217
222
-_Initialize_ new project
218
223
-_Open_ projects
219
224
220
225
### Project Information
226
+
221
227
In this section, it is possible to see the project's path, its app's database, and if the logged-in user has the
222
228
specific permission, this app can be removed from the project.
223
229
@@ -231,7 +237,7 @@ To initialize a project, it is necessary to indicate the project's path and prov
231
237
project's **project manager** who oversees the project.
232
238
233
239
> **WARNING**: Avoid to lose project manager's password, because the nature of this application makes it impossible
234
-
to recover password without previously login.
240
+
> to recover password without previously login.
235
241
236
242
If the indicated project is already initialized, checking _force initialize_ is possible to
237
243
re-initialize project.
@@ -241,10 +247,10 @@ re-initialize project.
241
247

242
248
243
249
Open project is possible in two-way:
250
+
244
251
- Manually entering the path
245
252
- Selecting the path from a set of already opened projects
246
253
247
-
248
254
# Documentation for Developers
249
255
250
256
This is a basic and simple documentation to illustrate this project to both old and new developers.
@@ -270,6 +276,7 @@ To run Sphinx doc:
270
276

271
277
272
278
### AppManager and its Services
279
+
273
280
**AppManager** is the class which provides methods to manage this app.
274
281
In particular, AppManager has a set of _services_, which are classes that provide specific functionality.
275
282
For example `AuthService` provides _authentication system_.
@@ -278,10 +285,12 @@ AppManager **has only one** service reference for each type to avoid duplication
278
285
Therefore, the services need to be refreshed instead of re-instantiated.
279
286
280
287
#### ProjectManager
288
+
281
289
**ProjectManager** manage the _projects_, usually only one project at time.
282
290
It allows initializing a new project or opening an existing project.
283
291
284
292
#### AuthService
293
+
285
294
**AuthService** provides _authentication system_.
286
295
It also manages _vault_ (`vault.json`), where "remember me" user credentials are stored.
0 commit comments