Skip to content

Latest commit

 

History

History
60 lines (50 loc) · 2.16 KB

README.md

File metadata and controls

60 lines (50 loc) · 2.16 KB
Raw

star4bch

js-standard-style

This JavaScript web app is used to reward GitHub users for staring a project. The front end is a simple web form that a user inputs their GitHub user name and Bitcoin Cash (BCH) address. If the user has stared the selected repository, then they are sent $0.10 in BCH.

The software assumes that an OpenBazaar node is running on the same server. You can read the installation instructions here.

This web app was forked from this Koa boilerplate

Requirements

  • node ^8.9.4
  • npm ^5.7.1

Installation

git clone https://github.com/christroutner/star4bch
npm install
./install-mongo
npm start

Structure

├── bin
│   └── server.js            # Bootstrapping and entry point
├── config                   # Server configuration settings
│   ├── env                  # Environment specific config
│   │   ├── common.js
│   │   ├── development.js
│   │   ├── production.js
│   │   └── test.js
│   ├── index.js             # Config entrypoint - exports config according to envionrment and commons
│   └── passport.js          # Passportjs config of strategies
├── src                      # Source code
│   ├── modules
│   │   ├── controller.js    # Module-specific controllers
│   │   └── router.js        # Router definitions for module
│   ├── models               # Mongoose models
│   └── middleware           # Custom middleware
│       └── validators       # Validation middleware
└── test                     # Unit tests

Usage

  • npm start Start server on live mode
  • npm run dev Start server on dev mode with nodemon
  • npm run docs Generate API documentation
  • npm test Run mocha tests

Documentation

API documentation is written inline and generated by apidoc.

Visit http://localhost:5000/docs/ to view docs

License

MIT