Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theprofs/bitpaper-api-docs
Bitpaper's Public REST API documentation
https://github.com/theprofs/bitpaper-api-docs
api bitpaper docs documentation rest
Last synced: 2 days ago
JSON representation
Bitpaper's Public REST API documentation
- Host: GitHub
- URL: https://github.com/theprofs/bitpaper-api-docs
- Owner: TheProfs
- License: apache-2.0
- Created: 2021-06-16T13:56:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-20T23:14:02.000Z (over 1 year ago)
- Last Synced: 2025-01-09T18:46:19.878Z (11 days ago)
- Topics: api, bitpaper, docs, documentation, rest
- Language: SCSS
- Homepage: https://developers.bitpaper.io
- Size: 1.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Bitpaper API Docs
Bitpaper's public REST API docs, built using [Slate][slate].
## Install
Ensure you have all [system dependencies installed][slate-getting-started],
clone this repository, cd into it and then:
```bash
$ gem update --system
$ gem install bundler
$ bundle install
```
## Usage
## Run development server
```bash
bundle exec middleman server
# then visit http://192.168.10.1:4567
```
## Edit documentation
Simply edit `src/index.html.md`.
More info on [Slate's][slate] homepage.
Some sections are `includes` found in `src/includes/`
## Deploy to production
```bash
# Build docs
$ bundle exec middleman build
# Push to main branch:
$ git add --all
$ git commit -am"Added POST/ user"
$ git push origin main
```
Pushing to `main` branch automatically deploys on Heroku as
[bitpaper-api-docs][heroku-bitpaper-api-docs],
which is publicly accessible at https://developers.bitpaper.io
[slate]:https://github.com/slatedocs/slate
[slate-getting-started]:https://github.com/slatedocs/slate/wiki/Using-Slate-Natively
[heroku-bitpaper-api-docs]:https://dashboard.heroku.com/apps/bitpaper-api-docs
## Authors
Bitpaper LTD