Add local install instructions (work in progress)

This commit is contained in:
0x1eef 2023-03-29 13:14:33 -03:00
parent 419d4186cb
commit a217fcffc9
2 changed files with 46 additions and 0 deletions

View file

@ -24,6 +24,34 @@ for a copy of the license, and see
[TLDRLegal](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3)
for a short summary of the GPL.
<p align="center">
<strong>Local install</strong>
</p>
_Clone repository_
git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran
_Run dependency check_
The `bin/run-dependency-check` script will check that the required
dependencies are available: Ruby, NodeJS, nginx, et cetera.
$ ./bin/run-dependency-check
Assuming it was a success:
found: ruby
found: bundle
found: node
found: npm
found: nginx
found: doas
Otherwise, the dependencies that are missing will be listed. All
dependencies should be found before proceeding to the next step.
<p align="center">
<strong>Credits</strong>
</p>

18
bin/run-dependency-check Executable file
View file

@ -0,0 +1,18 @@
#!/bin/sh
require_dep() {
dep=$1
which -s $dep
if [ $? -eq 0 ]; then
echo found: $dep
else
echo $dep is required, but not installed
fi
}
require_dep ruby
require_dep bundle
require_dep node
require_dep npm
require_dep nginx
require_dep doas