-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add dosc about project tehcnologies and how to runt the server
- Loading branch information
Showing
2 changed files
with
32 additions
and
0 deletions.
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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Contributing to Samourai Wallet | ||
|
||
## Technologies and scope | ||
|
||
- Dependencies path: [package.json](https://github.com/Samourai-Wallet/samourai-dojo/blob/develop/package.json). | ||
- [Node.js](https://nodejs.org/en/download): cross-platform, open-source JavaScript runtime environment. | ||
- [Mocha](https://mochajs.org/): automated tests and code coverage. | ||
- Developer's documentation path: [doc/guides/](https://github.com/Samourai-Wallet/samourai-dojo/tree/develop/doc/guides/). | ||
- Arquitecture: | ||
- Database: |
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 |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# How to run | ||
|
||
First, verify the compatible node version in package.json and install node.js. | ||
|
||
Now, install project dependencies: | ||
``` | ||
npm install | ||
``` | ||
|
||
create a index.js file in path: keys/ | ||
|
||
Add in file code the mainet or testnet parameters. | ||
You can find mainet and testnet parameters in keys/index-example.js. | ||
|
||
``` | ||
export default { | ||
// Mainnet parameters | ||
bitcoin: { | ||
// Mainet settings | ||
} | ||
} | ||
``` |