README.md 1.75 KB
Newer Older
Magnus Pedersen's avatar
Magnus Pedersen committed
1
# Alfy
Magnus Pedersen's avatar
Magnus Pedersen committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

## Quick setup:
Install node 4, I recommend getting a newer version. See below for instructions:
```sh
sudo apt install nodejs nodejs-legacy npm 
```
While connected to **Redpills VPN**
```sh
sudo npm --registry=http://185.47.40.90 install -g alfresco-tool  
```

usage:
```sh
alfy --help 
```

Magnus Pedersen's avatar
Magnus Pedersen committed
18
## Installning node
Michael Bui's avatar
Michael Bui committed
19 20 21 22
```
npm install npm@latest -g
```

Magnus Pedersen's avatar
Magnus Pedersen committed
23
#### Requires at least node 4
Magnus Pedersen's avatar
Magnus Pedersen committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
Debian/ubuntu 16.04
This will install node 4.
```sh
sudo apt install nodejs nodejs-legacy npm 
```

If you want a newer version use you can upgrade by doing:
```
sudo npm cache clean -f 
sudo npm install -g n 
sudo n stable
```
or if you want to receive updates from apt:
Version 6:

```
curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
sudo apt-get install -y nodejs
```

Version 8:
```
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
```
49

Magnus Pedersen's avatar
Magnus Pedersen committed
50 51 52
## Installing alfresco-tool (alfy)

While connected to **Redpills VPN**
53 54 55
```sh
sudo npm --registry=http://185.47.40.90 install -g alfresco-tool  
```
Magnus Pedersen's avatar
Magnus Pedersen committed
56
alfresco-tool creates a runnable script called: **`alfy`**
57 58 59 60

usage:
alfy --help

Magnus Pedersen's avatar
Magnus Pedersen committed
61

Magnus Pedersen's avatar
Magnus Pedersen committed
62

Michael Bui's avatar
Michael Bui committed
63
## Contribute:
Magnus Pedersen's avatar
Magnus Pedersen committed
64 65 66 67

Clone this repo.
Run the following to install dependencies. 
```sh
Michael Bui's avatar
Michael Bui committed
68
npm install --unsafe-perm
Magnus Pedersen's avatar
Magnus Pedersen committed
69 70 71 72
```
Use link to link to the alfy script to your local copy. 
e.g. /usr/bin/alfy -> projects/alfresco-tool/dist/index.js
```sh
Michael Bui's avatar
Michael Bui committed
73
sudo npm link --unsafe-perm
Magnus Pedersen's avatar
Magnus Pedersen committed
74 75 76 77 78 79 80 81 82 83 84 85
```

Some of the code is ES6 and maybe even ES7. 
So to make it compatible with node 4, which is the default installed by the package manager for man
Debian based distros. Babel is used.

So after you make changes build with:

```sh
npm run build 
```

Magnus Pedersen's avatar
Magnus Pedersen committed
86 87 88 89 90 91
Publish:
alfresco-tool is hosted on a private registry: http://185.47.40.90
To publish, bump version and run:
```sh
npm publish ./
```
Magnus Pedersen's avatar
Magnus Pedersen committed
92 93 94



Magnus Pedersen's avatar
Magnus Pedersen committed
95
[TODO](TODO.md)