sufone / qawl Goto Github PK
View Code? Open in Web Editor NEW📖 Quran Reader for Linux, Windows, macOS
Home Page: https://qawl.app
License: GNU Affero General Public License v3.0
📖 Quran Reader for Linux, Windows, macOS
Home Page: https://qawl.app
License: GNU Affero General Public License v3.0
Quickly: I love Linux and want to offer a version, don't have a copy installed now (but want to install Elementary OS 6 when it's out) or the time to do it. I would like to provide AppImage and snap files
If anyone is on Linux and wants this app, I would really love help building it for Linux! The readme
of this repo has the instructions, and it should very little time for you (and maybe a bit to download the high quality Quran images)
Let me know and I can help you do it.
Users can
Will also be nice and allow for multiple external hyperlink buttons (each configured to a different reference) :)
Qawl is so light that even in emulation mode it should perform as usual without any issue, but this should be taken care of.
Electron builder would also need to support this, I think 🤔
Then need to setup #22 to make these
I suggest adding an option for showing a single page per layout (it could be a switch/radio button)
I initially started with my personal task system on Notion, as mentioned in #1, but that's a very poor choice for a (hopefully) community project.
This is important, so users can install this new codebase ASAP, and be in line to receive updates
Till then, must show scroll bars
The whole app is pretty decent I think, with comments where beneficial
But the variable, function and component names - even if mostly clear - are not consistent, and won't be intuitive for someone new to the codebase.
In the future, I will be more careful about this from the get-go, God willing, but for now we must repair:
The function is running correctly and it shows in the console
Probably some issue with Electron window config
But it works fine in windows
I've been meaning to learn how to write tests… something I hope to do still
If someone could contribute tests it would be really helpful to speed up releases, and would be a great learning opportunity for me as well!
Have sensible maximum and minimum
Salam
May Allah reward you for the great work
I'd like to request for a Mac version of the app when possible.
Thanks.
Automatic at set time by user? Follow system theme? Manual using a button / keyboard shortcut?
Many users / systems don't properly use system theme, so maybe we should avoid it
Important to encourage community involvement
Solve #13 and #11 – just need to bother set it up and test it works. I had a bad experience with travis CI a few years back, and don't want to put time working on the build process when I need to work on feature parity with the old version also
Can use this https://github.com/samuelmeuli/action-electron-builder
See: https://github.com/batoulapps/quran-svg
Their processed PNGs are higher quality and smaller in size than the current ones here
And even better… use custom CSS for the original SVG pages along with a future theming system (#8)… but using SVGs instead of standard raster images brings other layout (ie. sizing) challenges
Closing #34, but this remains for a later date
Contributions most welcome!
Like #41
Low priority, relatively, but important for a good experience.
Just need to read a lot of documentation from https://electron.build, and convert/resize assets and put them in the right palce
See Phopsphor: https://github.com/phosphor-icons/phosphor-home
Really like their style, and they have all the icons we need
Problem: No svelte package for easy integration (with tree-shaking)…
They may not know development has shifted to here completely, and that future versions are here only
They may also want to star this new repo and keep up with new updates
Made a big mistake by not setting this up, will make a release ASAP to get this out
Like implemented in old Qawl
Todo:
simple electron API implementation, app already tracks current surah in store
To update on the site
Use Svelte Stores to load theme across the app
Make an easy JSON style format where users can easily create themes, and make a PR to include them in the next update
Support setting independent dark and light themes (switching mechanism between dark and light... is more complicated #18 .)
Don't know if this is an issue but page 444 (Yā Sīn) is in colour and the others are not!
All good!
Can use left right buttons easily.
I imagine the implementation to be: A total of 3 pairs of pages: one in the middle that is currently on screen for the user, one on the left that is current +2 / +1, and another pair on the right that is current -1 / -2. These pairs are set dependent on the current page, and changing page by either dragging or "next/prev page" buttons can do a smooth scroll.
Potential issues:
The issues seem large and annoying, so this is low priority. But it's worth experimenting with in some branch.
Strings are ready as in #35, just implement something like tippy
That last todo is the reason behind using a library — to enable easy toggle of this
Hi, welcome 👋🏽
Currently using Notion to track development and progress: [remove - notion sharing is being bad]
Feel free to check if what you want is there already, or let me know any thoughts.
The #1 Priority is to reach feature parity with the old version
Waiting till #23 is done
For both tafsir and recitation purposes
Recitation:
There's something by quranacademy
link to Quranwbw too
First step for #23
Was having a persistent problem that resulted in a blank white screen upon launching Qawl either from an installed build (tried v0.0.3 and v0.0.4), or a dev server using the latest code. Seem related to what was reported in #11. Got an error:
Unexpected token u in JSON at position 0
And the files/lines cited didn't have any issue. Tried deleting node_modules and re-installing, didn't work. Uninstalling Qawl and deleting it's install directory from %appdata% on windows did the trick, and now the installed build v0.0.4 works. and
I'll leave this issue open until a few months go by and this issue doesn't re-appear, or we are able to pinpoint what caused this.
My dev server still fails to load the app, but at least it's giving a different error I can debug. Sigh. This really must be what #11 was facing, when BiL reported a blank white screen after building a version cloning the code from master!
Related to #3, from which the provider can be selected. Can offer:
Free for open source, and would make life simpler
There's a nice electron build github action package, but it might be better long term to handcraft the actions
Going with a notification – it's disrespectful imo to auto download a release in the background, especially for a large app like Qawl
This way, I can quite easily have a message show up in the user's app on launch as well 🤩
As mentioned by @mbnoimi in #13
The error talks about CSP which is relevant when there are pages loaded from the internet, and Qawl doesn't load any part of the app from the internet
Anyways, I'll add the relevant security policy things soon
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.