From e78dbf117f9af4cad5e94e157f419c3398725b82 Mon Sep 17 00:00:00 2001 From: Manish Date: Sat, 25 Apr 2020 05:32:18 +1000 Subject: [PATCH] Copied some documentation temporarily from wiki repo to README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 8823d0b..095c1bc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # Backendless search and website generator from activity bundles prototype +## Instruction to use + +Steps: +1. Download & extract this app store repository +2. run main.py script in generator folder as: + +``` +$ python3 main.py "/bundles/directory" "/website/template/root/directory/ +``` + +All sub-directories of bundles directory will be scanned for activity +bundles i.e. .xo files. + +**WARNING:** for now website template has symblink of search.html as index.html. I do not know if it works in Windows OS. If not, delete index.html and copy search.html as index.html. + +**WARNING 2**: error log files and info.json file will be saved in website root directory for now. delete them if not needed. + +**WARNING3:** In prototype, paths are written in Unix style so likely won't work on Windows. This will be corrected after some time. For now, you can replace '/' with '\'. Also, I do not think (unsure) current directory is represented as './' (or even '.\') in Windows. So maybe remove that as well. + +## Issues +### What should be the license for the project? +I am OK with any FSF approved license which is suitable for Sugarlabs needs. + +### Should there be fallback backend when js is disabled in browser for search functionality to work? + +## To-DO +- [x] Create search function js file, JSON data file & html page stitching them together +- [ ] NOTE: how will I ensure that results are presented in some order when more than one search result is of equal standing in term of keywords match/ranking etc. Popularity/download counts or newest/last updated? +- [ ] Python script to automatically add all apps to app store, generate html pages and append entry to JSON search index file. +- [x] Create demo website +- [ ] Add copyright & license information +- [ ] For production version, compress index.json file. Also use compressed version of jquery. +- [ ] in parent directory of website write a script to start static file server serving website sub-directory. This will be used when not using web server such as Nginx or Apache for acting as backend eg. a user can start server from usb stick. +- [x] in live website, a link to download entire website (as pre generated zip file?)