al-quran.reflectslight.io/README.md

33 lines
855 B
Markdown
Raw Normal View History

2022-11-02 02:46:02 +01:00
## About
2023-02-21 01:03:43 +01:00
A static website for reading The Quran.
2022-11-19 22:46:28 +01:00
<br>
2023-02-21 01:26:59 +01:00
Built with a static website generator.
2023-02-21 01:03:43 +01:00
<br>
The website can be seen live at
2022-11-02 02:46:02 +01:00
[https://al-quran.reflectslight.io](https://al-quran.reflectslight.io).
2023-02-21 02:40:40 +01:00
## Stack
2022-11-02 02:46:02 +01:00
The main components of the website's stack are:
2023-02-21 01:26:59 +01:00
- Ruby v3.1.2+ <br>
The static site generator [nanoc](https://nanoc.app) is written in [Ruby](https://www.ruby-lang.org).
- NodeJS v16.16.0+ <br>
The website uses [NodeJS](https://nodejs.org) for [webpack](https://webpack.js.org/).
- TypeScript, React, and SCSS.
2022-11-02 02:46:02 +01:00
2023-02-21 01:26:59 +01:00
Follow [guides/localsetup.md](guides/localsetup.md) to setup the website on your computer.
2022-11-02 02:46:02 +01:00
2022-11-18 01:21:30 +01:00
## Authors
* Gyen Abu Bakar [@gyenabubakar](https://github.com/gyenabubakar)
* 0x1eef [@0x1eef](https://github.com/0x1eef)
2022-11-02 02:46:02 +01:00
## License
2023-02-21 01:03:43 +01:00
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
<br>
See [LICENSE](./LICENSE).