Skip to content

Commit c1e178d

Browse files
WillLefterisJP
Will
authored andcommitted
Add doc about install on OSX
1 parent b690f66 commit c1e178d

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

README.md

+47-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Install electron and any other npm dependencies by:
2424
npm install --runtime=electron --target=1.8.4
2525
```
2626

27-
Create a new [virtual environment](http://docs.python-guide.org/en/latest/dev/virtualenvs/) to install all the python dependencies. If you don't have `mkvirtualenv` then check how to get it depending on your distribution. [Here](http://exponential.io/blog/2015/02/10/install-virtualenv-and-virtualenvwrapper-on-ubuntu/) is a guide for Ubuntu and [here]https://wiki.archlinux.org/index.php/Python/Virtual_environment) is one for ArchLinux.
27+
Create a new [virtual environment](http://docs.python-guide.org/en/latest/dev/virtualenvs/) to install all the python dependencies. If you don't have `mkvirtualenv` then check how to get it depending on your distribution. [Here](http://exponential.io/blog/2015/02/10/install-virtualenv-and-virtualenvwrapper-on-ubuntu/) is a guide for Ubuntu and [here](https://wiki.archlinux.org/index.php/Python/Virtual_environment) is one for ArchLinux.
2828

2929
```
3030
mkvirtualenv rotkehlchen
@@ -39,6 +39,52 @@ pip install -r requirements.txt
3939

4040
Now to start the application you need to type `npm start`.
4141

42+
### OSX
43+
44+
NOTE: While possible, the installation on OSX is still unsupported.
45+
46+
The <tldr> version is:
47+
- install sqlcipher
48+
- use a virtual env with python 3.6.x
49+
- make sure pip installed everything it says it installed
50+
- get your node under control with nvm, i tested 8.9
51+
52+
The following recipe has been tested using [Anaconda](https://conda.io). [VirtualEnv](https://virtualenv.pypa.io) works as well, refer to the documentations of those projects to install and use them.
53+
54+
Rotkehlchen uses an encrypted database called [SQLCipher](https://www.zetetic.net/sqlcipher/). Before we can proceed, we need to install it. Homebrew makes it simple:
55+
56+
$ brew update && brew install sqlcipher
57+
58+
If you wish to use Conda, use the following commands:
59+
60+
$ brew cask install caskroom/cask/anaconda
61+
$ echo "export PATH=$PATH:/usr/local/anaconda3/bin" >> ~/.bash_profile
62+
$ echo ". /usr/local/anaconda3/etc/profile.d/conda.sh" >> ~/.bash_profile
63+
$ source ~/.bash_profile
64+
$ conda create python=3.6 --name rotkehlchen
65+
$ conda activate rotkehlchen
66+
67+
Before using `pip`, let´s ensure we have the latest version:
68+
69+
$ pip install --upgrade pip
70+
71+
Install all the requirements:
72+
73+
$ sudo pip install -r requirements.txt
74+
75+
Rotkehlchen uses electron, we need to install it:
76+
77+
$ npm install --runtime=electron --target=1.8.4
78+
79+
Almost there, we can now install all the NodeJS dependencies. Using a recent NodeJS version such as 8.9.x, it should be smooth
80+
81+
$ npm install
82+
83+
You now deserved to start Rotkehlchen:
84+
85+
$ npm start
86+
87+
4288
## Love it? Want to help?
4389

4490

0 commit comments

Comments
 (0)