Crossroads is a REST api server capable of creating and managing P2PSP channels.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
configs
controllers
docs
engine
models
public
routes
tests
views
.editorconfig
.eslintrc.json
.gitignore
.travis.yml
LICENSE
README.md
app.js
engine.js
package.json
yarn.lock

README.md

crossroads Build Status codecov codebeat badge

P2PSP server implementation

How to start?

  • Clone the repo - git clone https://github.com/agauniyal/crossroads
  • Install required dependencies cd crossroads && npm install --production (for yarn, replace npm install with yarn and keep the --production flag as it is)
  • Start the server - npm start (for yarn, use yarn start)

Make sure you have latest node version (node v8 currently), though it should work with v7 as well. Crossroads is continously tested on Travis CI against Node v8 and latest Node version.

How to develop?

  • Clone the repo - git clone https://github.com/agauniyal/crossroads
  • Install required dependencies cd crossroads && npm install (for yarn, replace npm install with yarn)
  • Start the server - npm run dev (for yarn, use yarn dev)
  • Make changes, update test files in tests directory and run tests - npm test or yarn test
  • At the end, make sure to generate docs via - npm run gen-docs and npm run gen-docs-html command (for yarn - yarn gen-docs and yarn gen-docs-html)

Make sure to check out auto-generated documentation as well.