sugarlabs/appstore
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
App store for Python 3 activities https://activities.radii.page/
3 Commits 2 Branches 0 Tags 768 KiB
Python 59.1%
JavaScript 22%
CSS 10.9%
HTML 8%
e78dbf117f
Go to file
Manish e78dbf117f Copied some documentation temporarily from wiki repo to README.md
2020-04-27 14:21:49 +10:00
generator Prototype of offline/backendless search functionality and generating/building website from activity bundles (NOTE: cannot add incrementally new activity bundles for now as it will overwrite search index rather than appending to it) 2020-04-27 14:21:49 +10:00
website Prototype of offline/backendless search functionality and generating/building website from activity bundles (NOTE: cannot add incrementally new activity bundles for now as it will overwrite search index rather than appending to it) 2020-04-27 14:21:49 +10:00
.gitignore Initial commit 2020-04-21 04:18:21 +02:00
LICENSE Initial commit 2020-04-21 04:18:21 +02:00
README.md Copied some documentation temporarily from wiki repo to README.md 2020-04-27 14:21:49 +10:00

README.md

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

  • 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.
  • 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.
  • in live website, a link to download entire website (as pre generated zip file?)