https://github.com/bitcoin-com/cloudrest.bitcoin.com

REST layer for Bitcoin.com's cloud
https://github.com/bitcoin-com/cloudrest.bitcoin.com

Last synced: about 2 months ago
JSON representation

REST layer for Bitcoin.com's cloud

• Host: GitHub
• URL: https://github.com/bitcoin-com/cloudrest.bitcoin.com
• Owner: Bitcoin-com
• License: mit
• Created: 2018-08-28T16:09:29.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-06T01:20:35.000Z (over 7 years ago)
• Last Synced: 2025-01-26T06:25:30.161Z (over 1 year ago)
• Language: JavaScript
• Size: 234 KB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# cloudrest.bitcoin.com

REST API for Bitcoin.com's Cloud.

## Usage

### Installation

Clone the repo

`git clone https://github.com/Bitcoin-com/cloudrest.bitcoin.com.git`

Install the deps

`cd cloudrest.bitcoin.com && yarn install`

Start the app

- `yarn start` Start server on live mode

- `yarn run dev` Start server on dev mode with nodemon

- `yarn run docs` Generate API documentation

- `yarn test` Run mocha tests

### Start dev server

- Ensure mongodb is running

- Set defaults in seed-db.js

- `yarn run seed` Seed dev appsettings

- Configure kubernetes and gcloud credentials

- `yarn start tasks` Start tasks process

- `yarn run dev` Start rest server

## Documentation

API documentation is written inline and generated by [apidoc](http://apidocjs.com/).

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

## License

MIT

Forked from https://github.com/christroutner/babel-free-koa2-api-boilerplate

[![Coverage Status](https://coveralls.io/repos/github/Bitcoin-com/cloudrest.bitcoin.com/badge.svg?branch=master)](https://coveralls.io/github/Bitcoin-com/cloudrest.bitcoin.com?branch=master)