ReflectsLight/al-quran.reflectslight.io
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: update

Browse source
This commit is contained in:
0x1eef 2024-03-15 14:32:31 -03:00
parent bb2d3549d3
commit cee85d98f9
1 changed files with 15 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,7 +1,7 @@
## About ## About
This repository contains the source code of This repository contains the source code of
[al-quran.reflectslight.io](https://al-quran.reflectslight.io), [al-quran.reflectslight.io](https://al-quran.reflectslight.io) -
a static website for reading (and listening to) The Noble Quran. a static website for reading (and listening to) The Noble Quran.
After the website is built, the build directory consists of HTML, After the website is built, the build directory consists of HTML,
CSS, JavaScript and other static assets that can be hosted by a CSS, JavaScript and other static assets that can be hosted by a
@ -18,28 +18,20 @@ the website can be built:
There is a good chance there's a package available for There is a good chance there's a package available for
tidy-html5 on your operating system of choice. tidy-html5 on your operating system of choice.
## Local development ## Development
__1. Clone__
# Clone repository
git clone https://github.com/ReflectsLight/al-quran.git git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran cd al-quran
__2. Install Ruby, NodeJS packages__ # Install Ruby, NodeJS packages
bundle install bundle install
npm i npm i
__3. Build website__ # Build website
# Build once
rake build rake build
# Build whenever a change is detected # Start web server
rake build:watch
__4. Start server on localhost__
rake server rake server
## Thanks ## Thanks
@ -47,9 +39,14 @@ __4. Start server on localhost__
First and foremost, Alhamdulillah. First and foremost, Alhamdulillah.
* Thanks to the following graphic artists: * Thanks to the following graphic artists:
* [RefreshIcon](/src/js/components/Icon.tsx) - [RefreshIcon](/src/js/components/Icon.tsx)
by by
[Muhammad Haq](https://freeicons.io/profile/823). [Muhammad Haq](https://freeicons.io/profile/823).
* Thanks to the following translators: * Thanks to the following translators:
* English (The Clear Quran) by Dr. Mustafa Khattab - English (The Clear Quran) by Dr. Mustafa Khattab
## License
The "source code" is released under the terms of the GPL. <br>
See [./LICENSE](./LICENSE) for details.