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
- Signed-off commits were missing
- Dumb pseudo was used in history
- Change of email from Gmail to self-hosted mail has been fucked up
Signed-off-by: Pierre-Yves Lapersonne <dev@pylapersonne.info>
Copy file name to clipboardExpand all lines: CREDITS.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,6 @@ Logo of the project used in this repo and in the web view:
4
4
5
5
**Picture made by <ahref="https://www.flaticon.com/authors/freepik">Freepik</a>, under <ahref="https://file000.flaticon.com/downloads/license/license.pdf">Flaticon Basic License</a> from <ahref="www.flaticon.com">Flaticon</a>**
6
6
7
-
Navigation pictures of the project used in the web view:
7
+
Navigation pictures of the project used in t the web view:
8
8
9
9
**Pictures made by <ahref="https://www.flaticon.com/authors/dave-gandy">Dave Gandy</a>, under <ahref="https://creativecommons.org/licenses/by/3.0/">CC 3.0 BY</a> from <ahref="www.flaticon.com">Flaticon</a>**
2
2
3
-
# Tips'n'tools (v14.3.3)
3
+
# Tips'n'tools (v14.2.0)
4
4
5
5
<em>Keep time and be faster with your own cache of references, tools and specifications useful for developers.</em>
6
6
7
-
_Tips'n'tools_ is a project which has the aim of making searches faster and improving technical watch.
7
+
_Tips'n'tools_ is a project whch has the aim of making searches faster and improving technical watch.
8
8
Indeed, sometimes you need to share usefull web links and cool libraries to your colleagues, but which platform to use?
9
9
Your company's inner social network? Lost time if you move from your job.
10
10
A public social media? Lost time if this medium is closed.
11
11
Fill your web browser's bookmarks? Yeah, got stolen or reinitialized your computer and you are done.
12
12
13
-
_Tips'n'tools_ allows you to fill a spreadsheet (_.ods_ file) and then export its sheets to CSV files (ok it's old school).
13
+
_Tips'n'tools_ allows you to fill a spreadsheet (_.ods_ file) and then export its sheets to CSV files.
14
14
Then you can:
15
-
- use the main Shell script (_tipsntools.sh_) to make queries so as to find a thing you have listed (hey, just CLI, no GUI)
16
-
- build a little Progressive Web App (a Single Page Application) which allows you to make queries with a more user-friendly UI (but can be improved a lot)
17
-
- update a global web page if you cannot use the web app (quit heavy if you have plenty of content to show)
18
-
- run the server-side feed script, written in _Ruby_, so as to expose an HTTP API to make the queries from everywhere (Ruby servlet calling Shell scripts, quite dumb)
19
-
- place all of this project in your web server, and make the Ruby script or the web app available for your friends or colleagues (but web-voodoo-glue might be required)
15
+
- use the main Shell script (_tipsntools.sh_) to make queries so as to find a thing you have listed
16
+
- build a little Progressive Web App (a Single Page Application) which allows you to make queries with a more user-friendly UI
17
+
- update a global web page if you cannot use the web app
18
+
- run the server-side feed script, written in _Ruby_, so as to expose an HTTP API to make the queries from everywhere
19
+
- place all of this project in your web server, and make the Ruby script or the web app available for your friends or colleagues
20
20
21
-
_Tips'n'tools_ may be useful if you want to compile, in one place, plenty of references and data interesting for your projects.
21
+
22
+
_Tips'n'tools_ may be useful if you want to compile, in one place, plenty of references and data interesting for your projects.
22
23
Never rely on social networks or corporate heavy tools, make your own cache and bring it everywhere!
23
24
25
+
**If you read this document through the GitHub repository, click <ahref="https://rawgit.com/pylapp/Tips-n-tools/content/build/webapp.html">here</a> instead.**
24
26
25
27
## The main script
26
28
@@ -44,51 +46,43 @@
44
46
45
47
## Add new elements in spreadsheets and other files
46
48
47
-
You can fill the _.ods_ spreadsheet file with new data you want to save. Then run
49
+
You can fill the .ods spreadsheet file with new data you want to save. Then run
48
50
```shell
49
51
bash tipsntools.sh --update
50
52
```
51
-
to update the _.html_ and _.json_ files.
53
+
to update the .html and .json files.
52
54
53
55
## Who's who
54
56
55
57
The main script (_tipsntools.sh_) calls core's Shell scripts (stored in _utils/core_ folder) to play with CSV files (in _contents_ folder).
56
58
The server-side script (_datafeed.rb_) calls the main script to process the queries.
57
59
The web app is defined in the _utils/webapp_ folder, and if the web browser is not suitable, the web page (defined in _utils/webpage_ folder) can be used instead.
58
60
The web app and the web page to use are in the _builld_ folder (their assets are copied from _utils_).
59
-
Finally, the CSV files you should create, and the generated _.json_ and _.html_ files are in the _contents_ folder.
61
+
Finally, the CSV files you should create, and the generated .json and .html files are in the _contents_ folder.
60
62
61
63
## Customize the project
62
64
63
65
In most of case nothing is hard-coded. Feel free to customize the Shell scripts, the HTML assets, etc.
64
-
The thing is, if you want to add a column in one of the spreadsheet's sheets, do not forget to update the dedicated Shell scripts and the HTML elements (CSS style sheets, HTML tables, etc.).
66
+
The thing is, if you want to add a column in one of the spreadsheet's sheets, do not forget to update the dedicated Sheel scripts and the HTML elements (CSS styl sheets, HTML tables, etc.).
65
67
66
68
## Run the web app
67
69
68
70
The web app here is a kind of "Progressive Web App" as a "Single App Application" (one page, offline, installable, with a cache, responsive, etc), BUT it remains web before all.
69
-
So because web browsers world is fu****g missy (and also coz' I enjou native apps <3), it remains web browsers which do not support Service Workers, Web Workers, IndexedDB, Promises, ES6 or common and nowadays tools.
71
+
So because web browsers world is fu****g missy, it remains web browsers which do not support Service Workers, Web Workers, IndexedDB, Promises, ES6 or common and nowadays tools.
70
72
Thus you should use an up-to-date web browser. And sometimes it still won't work. "Web is universal and cool" they said x-)
71
73
Because Service Workers are used, you should reach the web app through HTTPS or a local web server (_localhost_).
72
74
73
-
_If you saw newbie things I did, feel free to submit a pull request!_
74
75
75
76
## Requirements
76
77
77
78
- Operating system which can use **Shell** (BASH) and **Ruby** scripts (macOS, Linux, ...)
78
79
-**Up-to-date web browser** compatible with IndexedDB, Web Workers, Service Workers, ES6, JS' Promises... (Firefox 58.0.2+, Chromium 64.0.+, ...)
79
-
- Something which can deal with _.ods_ file (_Libre Office_, _Open Office_, ...)
80
-
81
-
For macOS users, you should install the _truncate_ command:
82
-
```shell
83
-
brew install coreutils
84
-
brew install truncate
85
-
# Maybe you should after run `brew link truncate`
86
-
```
80
+
- Something which can deal with .ods file (Libre Office, Open Office, ...)
87
81
88
82
## Deploy it
89
83
90
84
To deploy this project for you, your colleagues, your team or whoever, here are the steps:
91
-
- get this project (download, fork, clone, summon, teleport ...)
85
+
- get this project (download, fork, clone, summon, ...)
92
86
- customize elements if you want (columns, styles, ...)
93
87
- fill the ODS file
94
88
- run the update command to produce the CSV, HTML and JSON files
@@ -105,25 +99,3 @@ Here is the file tree for this version:
105
99
106
100
It seems some web browsers (Firefox 58 for Android and Ubuntu) have bugs with IndexedDB. So you won't use the web app with them.
107
101
You ask why Shell and Ruby are used instead of full cross-platforms languages? Power, effectiveness, and free and open-source OS ;-)
108
-
109
-
## Must-read note
110
-
111
-
Because there are differences and gaps between commands on macOS and GNU/Linux, the project in its v14.3.0 release will not work on macOS! v14.3.1 may be broken on macOS for HTML content production.
112
-
In fact numerous commands like _truncate_, _sed_, and MD5 or SHA1 checksums are not implemented, have different names or have a different behavior.
113
-
114
-
Thus for macOS users **you must use** the v14.3.3 release, and for GNU/Linux users **you have to use** the v14.3.0 release.
115
-
116
-
Have a look on the [release note](https://github.com/pylapp/Tips-n-tools/blob/master/CHANGELOG.md) to get more details.
117
-
118
-
## Know issues
119
-
120
-
If you get errors like _sed: RE error: illegal byte sequence_, please refer to the hyperklink bellow.
121
-
It seems some files (like CSV files) you produce contain special characters '�' making `sed` fail.
You may also have in the wepp app error like _"An error occured with the JSON data gotten from the feed Web API. The degraded mode is still available"_. By looking in the developer console, you may find there is unexpected error in the JSON data returned by the script.
125
-
In this case you should have a look on the CSV files you exported ; maybe there are not well formatted and make the produced JSON bad.
126
-
127
-
In addition, if you isntall the web app on your computer, you may have different behaviors if you choose Brave, Chrome or Firefox :-/
128
-
129
-
More details on the [issues tracker](https://github.com/pylapp/Tips-n-tools/issues).
0 commit comments