Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
nricciardi committed May 27, 2023
1 parent 8ba7593 commit e637329
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

This is a university project for teaching object-oriented programming at UniMoRe university (a.y. 2022/2023).


- [Taskup](#taskup)
* [Get Started](#get-started)
+ [Dependencies](#dependencies)
Expand Down Expand Up @@ -72,6 +71,8 @@ After dependencies installation, this app can be opened using `main.py`.

`main.py` accepts some parameters based on execution modality.

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`.

#### Modality

- `run`, `r` or _nothing_: launch the application
Expand All @@ -89,6 +90,7 @@ It is possible to manage application settings using `settings.json`, this file h
Inserting custom settings in it, they override base default settings (managed by `SettingsManager`).

The settings available are:

- `vault_path`, a string that contains the path of directory in which will be saved the file which stores user's credentials
- `current_project_path`, a string which contains the project path which will be loaded at the beginning
- `projects_stored_paths`, a list of strings which contains the paths of already opened projects
Expand All @@ -106,6 +108,7 @@ The settings available are:
- `edge` to open app in Edge browser

## Contribute

Everyone can contribute to this project.

Contributing is possible via pull request. You can develop something present in the [TODO](TODO.md) file or new feature from scratch.
Expand Down Expand Up @@ -212,12 +215,15 @@ For example, the _Manage Task Label_ page looks like this:
In addition, if there are a lot of resources, it is possible to use filters.

## Home

**Home page** provides a set of sections where is possible:

- Watch _project information_
- _Initialize_ new project
- _Open_ projects

### Project Information

In this section, it is possible to see the project's path, its app's database, and if the logged-in user has the
specific permission, this app can be removed from the project.

Expand All @@ -231,7 +237,7 @@ To initialize a project, it is necessary to indicate the project's path and prov
project's **project manager** who oversees the project.

> **WARNING**: Avoid to lose project manager's password, because the nature of this application makes it impossible
to recover password without previously login.
> to recover password without previously login.
If the indicated project is already initialized, checking _force initialize_ is possible to
re-initialize project.
Expand All @@ -241,10 +247,10 @@ re-initialize project.
![Home open](./doc/img/usr-doc/home-open.png)

Open project is possible in two-way:

- Manually entering the path
- Selecting the path from a set of already opened projects


# Documentation for Developers

This is a basic and simple documentation to illustrate this project to both old and new developers.
Expand All @@ -270,6 +276,7 @@ To run Sphinx doc:
![structure of the project](./doc/img/dev-doc/structure-diagram.jpg)

### AppManager and its Services

**AppManager** is the class which provides methods to manage this app.
In particular, AppManager has a set of _services_, which are classes that provide specific functionality.
For example `AuthService` provides _authentication system_.
Expand All @@ -278,10 +285,12 @@ AppManager **has only one** service reference for each type to avoid duplication
Therefore, the services need to be refreshed instead of re-instantiated.

#### ProjectManager

**ProjectManager** manage the _projects_, usually only one project at time.
It allows initializing a new project or opening an existing project.

#### AuthService

**AuthService** provides _authentication system_.
It also manages _vault_ (`vault.json`), where "remember me" user credentials are stored.

Expand Down

0 comments on commit e637329

Please sign in to comment.