Add bin/setup
This commit is contained in:
parent
610297f60a
commit
a07a784f7a
2 changed files with 16 additions and 12 deletions
21
README.md
21
README.md
|
@ -7,16 +7,14 @@ 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
|
||||||
standard web server (eg nginx, apache, ...).
|
standard web server (eg nginx, apache, ...).
|
||||||
|
|
||||||
## Stack
|
## Environment
|
||||||
|
|
||||||
The following languages and tools have to be installed before
|
The following languages and tools have to be installed to build
|
||||||
the website can be built:
|
the website from source:
|
||||||
|
|
||||||
* Ruby 3.1, or later.
|
* Ruby 3.1 (or later)
|
||||||
* NodeJS v18.15, or later.
|
* NodeJS v18.15 (or later)
|
||||||
* [tidy-html5](https://github.com/htacg/tidy-html5) <br>
|
* [tidy-html5](https://github.com/htacg/tidy-html5)
|
||||||
There is a good chance there's a package available for
|
|
||||||
tidy-html5 on your operating system of choice.
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
@ -24,9 +22,8 @@ the website can be built:
|
||||||
git clone https://github.com/ReflectsLight/al-quran.git
|
git clone https://github.com/ReflectsLight/al-quran.git
|
||||||
cd al-quran
|
cd al-quran
|
||||||
|
|
||||||
# Install Ruby, NodeJS packages
|
# Setup build environment
|
||||||
bundle install
|
bin/setup
|
||||||
npm i
|
|
||||||
|
|
||||||
# Build website
|
# Build website
|
||||||
rake nanoc:build
|
rake nanoc:build
|
||||||
|
@ -36,7 +33,7 @@ the website can be built:
|
||||||
|
|
||||||
## Thanks
|
## Thanks
|
||||||
|
|
||||||
First and foremost, Alhamdulillah.
|
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)
|
||||||
|
|
7
bin/setup
Executable file
7
bin/setup
Executable file
|
@ -0,0 +1,7 @@
|
||||||
|
#!/bin/sh -ex
|
||||||
|
|
||||||
|
##
|
||||||
|
# main
|
||||||
|
bundle install
|
||||||
|
npm i
|
||||||
|
git submodule update --init --recursive
|
Loading…
Reference in a new issue