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
{{ message }}
This repository was archived by the owner on Jan 14, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+58-6Lines changed: 58 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,36 +9,43 @@ Re-designs the way tasks, task info, tracked time and communication is done on r
9
9
10
10
The project was originally developed for a MVP portfolio showcase, but there is some roadmap planned with new features that might be added once I find enough of free time.
11
11
12
-
Thanks for using, or considering to use this project. I would love to hear some feedback as well as your suggestions and thoughts about what could be improved. If you have something to say, don't hesitate to [send me an email](mailto:[email protected]).
12
+
Thanks for using, or considering to use this project.
Created by [Daniyil Vasylenko](https://github.com/Spring3)
40
+
If you don't have access to a deployed instance of redmine, you can now run it in docker
41
+
42
+
Unfortuantely, you will have to configure it then yourself
43
+
44
+
```
45
+
docker-compose -f docker-compose.yml up
46
+
```
41
47
48
+
Then after you run the project with `npm run dev`, use `http://localhost` as redmine endpoint on the login form and provide the credentials or the API token
42
49
43
50
## FAQ
44
51
@@ -48,6 +55,51 @@ Created by [Daniyil Vasylenko](https://github.com/Spring3)
48
55
#### - Markdown is displayed incorrectly
49
56
Please ask your Redmine admin user to check if it's enabled in `Administration -> General -> Text Formatting` menu. This path may change with the upcoming redmine releases, so please refer to Redmine documentation to find out exactly where this switch is located for your version of Redmine
50
57
51
-
#### - My antivirus / Defender / Mac OS warns that it's not safe to run this app
58
+
#### - My antivirus / Defender / Mac OS warns that it's not safe to run this app
52
59
Mac OS build was signed by a **self-signed certificate**, while Windows and Linux builds **were not signed at all**. In such case, you will see this warnings upon download or running the application / installation, saying that this app is not safe to run or that it was provided by an unknown developer and is not safe to run.
53
60
61
+
#### - How to use timer controls
62
+
63
+
Timer controls allow to manually modify the time for the timer by (1 or 5 minutes back and forth) as well as write temporary comments. Using these, we can directly modify the time after the pause in the task. To enable it, toggle the "Use advanced timer controls" item in the Settings menu
64
+
65
+
#### - Idle behavior
66
+
67
+
Redshape can pause the timer if it detects the system is idle for a range of times (5, 10 o 15 minutes). It will warn with notifications (15s. warning time before pausing).
68
+
69
+
Optionally, it can automatically discard the idle time from the current timer when it is paused.
70
+
71
+
#### - More accurate progressbar
72
+
73
+
Issue progress slider can be changed with 1% step if configured (by default is 10%).
74
+
Enable this if you have support in the server side (ruby, redmine) to use every percentage (33%, 81%, etc).
75
+
76
+
### AUR package
77
+
78
+
Electron-builder does not offer aur packages. Therefore, in the directory `support/package-aur` we can build those for ArchLinux/Manjaro distributions. It is "optimized" and just installs around 50MiB, using the system electron, as it is exposed here [issue 4059](https://github.com/electron-userland/electron-builder/issues/4059).
79
+
80
+
```sh
81
+
bash support/package-aur/manager.sh pack # can be omitted if using the archive from the repo
82
+
bash support/package-aur/manager.sh makepkg
83
+
```
84
+
85
+
Before publishing a release, you have to update the PKGBUILD:
86
+
87
+
```sh
88
+
# using npm script:
89
+
npm run release:aur
90
+
91
+
# alternatively, with the shell:
92
+
bash support/package-aur/manager.sh pack pkgbuild
93
+
```
94
+
95
+
The second target (`pkgbuild`) will update the version and md5sums of the PKGBUILD.
0 commit comments