Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add dosc about project tehcnologies and how to run the server #181

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 Dojo

## 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
}
}
```