Skip to content

Commit

Permalink
docs: add dosc about project tehcnologies and how to runt the server
Browse files Browse the repository at this point in the history
  • Loading branch information
kayevo committed Mar 29, 2024
1 parent 8d01fc0 commit 8a5c84e
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
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:
22 changes: 22 additions & 0 deletions doc/guides/HowToRun.md
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
}
}
```

0 comments on commit 8a5c84e

Please sign in to comment.