Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,42 @@ | ||
# Lisk Inviter Core | ||
# Lisk Inviter - Core | ||
|
||
The Lisk Inviter client repository and documentation can be found [here](https://github.com/sidechain-solutions/lisk-inviter/tree/master/client). | ||
|
||
### Prerequisites | ||
|
||
First install the dependencies as detailed in the [Lisk SDK documentation](https://lisk.io/documentation/lisk-sdk/setup). | ||
|
||
- Node.js | ||
- PostgreSQL | ||
- Python | ||
- pm2 (recommended) | ||
|
||
### Installation | ||
|
||
``` | ||
git clone https://github.com/sidechain-solutions/lisk-inviter | ||
cd lisk-inviter | ||
npm install | ||
``` | ||
|
||
### Run | ||
|
||
Run the node and view logs: `node index.js | npx bunyan -o short` | ||
|
||
Run the node as a background service: | ||
|
||
Register name `pm2 start --name lisk-inviter index.js` | ||
|
||
To start and stop the process: | ||
|
||
``` | ||
pm2 start lisk-inviter | ||
pm2 stop lisk-inviter | ||
``` | ||
|
||
If you want the node to automatically start on (re)boot, execute the command that is generated by running: | ||
|
||
``` | ||
pm2 save | ||
pm2 startup | ||
``` |