Skip to content

Commit a4fc157

Browse files
committed
docs(dependencies): update dependencies.md doc file
1 parent 2498524 commit a4fc157

File tree

2 files changed

+106
-2
lines changed

2 files changed

+106
-2
lines changed

docs/DEPENDENCIES.md

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,107 @@
11
## Dependencies
22

3-
`Abstruse` requires `SQLite3` and `Docker` to be installed.
3+
`Abstruse` requires `sqlite3` and `Docker` to be installed.
4+
5+
### Contents
6+
7+
* [Ubuntu Linux](#ubuntu-linux)
8+
* [MacOS](#macos)
9+
* [Windows](#windows)
10+
11+
12+
### Ubuntu Linux
13+
14+
1. Install Node.JS
15+
16+
There are many ways installing Node.JS on Ubuntu. We will use an approach where you can later update, uninstall or use another version of Node.JS easily.
17+
First, make sure you have build-essential and libssl-dev installed.
18+
19+
```sh
20+
sudo apt-get install build-essential libssl-dev -y
21+
```
22+
23+
After you ran previous command and it has done with its work successfully its time to install nvm.
24+
25+
```sh
26+
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash
27+
export NVM_DIR="$HOME/.nvm"
28+
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
29+
```
30+
31+
This will load nvm in your current bash/zsh session. Now its finally time to install Node.JS:
32+
33+
```sh
34+
nvm install node
35+
```
36+
37+
2. Install sqlite3
38+
39+
```sh
40+
sudo apt-get install sqlite3 -y
41+
```
42+
43+
Check if installation was successful with running sqlite3 command.
44+
45+
3. Install Docker CE
46+
47+
```sh
48+
curl -fsSL get.docker.com -o get-docker.sh
49+
chmod +x get-docker.sh
50+
sudo ./get-docker.sh
51+
```
52+
53+
After script is done with its work add your user to the docker group. This will allow you running Docker containers with your user and not only root. janez stands for your username.
54+
55+
```sh
56+
sudo usermod -aG docker janez
57+
```
58+
59+
After this you need to open a new terminal where groups are populated again. There's no other way than opening new terminal/tab.
60+
61+
You can check if your user is in docker group with running.
62+
63+
```sh
64+
id
65+
```
66+
67+
If docker group is listed, you are on a good way. If not, check previous commands again.
68+
69+
Finally, start the Docker instance with running.
70+
71+
```sh
72+
sudo /etc/init.d/docker start
73+
```
74+
75+
### MacOS
76+
77+
This guide presumes you have brew command available. If not, quickly install it with.
78+
79+
```sh
80+
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
81+
```
82+
83+
...it also presumes that you have CommandLineTools installed.
84+
85+
```sh
86+
xcode-select --install
87+
```
88+
89+
1. Install Node.JS
90+
91+
There are other ways of installing Node.JS on MacOS, we will use more convenient one.
92+
93+
```sh
94+
brew install node
95+
```
96+
97+
2. Install sqlite3
98+
99+
Also, for sqlite3, we will use similar approach and use brew again.
100+
101+
```sh
102+
brew install sqlite3
103+
```
104+
105+
3. Install Docker
106+
107+
To install Docker on MacOS, download it from here and open Docker.dmg file. You will be guided through the installation and really there is not something that you can miss.

docs/INSTALLATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ this while using `abstruse` docker image.
2929

3030
3. Open Application
3131

32-
Run your favourite `Chrome` browser and navigate to `http://localhost:6500`. You should see `abstruse` setup page which will guide you
32+
Run your favorite `Chrome` browser and navigate to `http://localhost:6500`. You should see `abstruse` setup page which will guide you
3333
throught the initial setup.
3434

3535
### Install From npm

0 commit comments

Comments
 (0)