https://github.com/zonkyio/zscore-partner-api
Personal Score Partner API
https://github.com/zonkyio/zscore-partner-api
Last synced: 7 months ago
JSON representation
Personal Score Partner API
- Host: GitHub
- URL: https://github.com/zonkyio/zscore-partner-api
- Owner: zonkyio
- Created: 2021-06-07T13:26:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-15T08:00:26.000Z (over 4 years ago)
- Last Synced: 2025-01-25T17:10:00.730Z (9 months ago)
- Language: API Blueprint
- Size: 17.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Personal Score Partner API
Repository for Personal Score Partner API documentation.
## Local Development
You can build and export the documentation locally outside Apiary with a few simple steps. All you need is working Node.js environment on your machine.
1. Clone this repository
```bash
git clone git@github.com:zonkyio/zscore-partner-api.git
cd zscore-partner-api
```
2. Install project dependencies
```bash
npm install
```
3. Run development server
```bash
npm run dev
```
Server will start on `http://localhost:3000` and will listen for changes in `apiary.apib` file.
4. Export documentation
```bash
npm run build
```
## Local build with docker
1. Pull image
```bash
docker pull apiaryio/client
```
2. Export documentation
```bash
docker run -v $(pwd):/tmp apiaryio/client preview --output=/tmp/result.html --path=/tmp/apiary.apib
```
The documentation will be exported to a single `result.html` file.
## Further Reading / Useful Links
- [API Blueprint](https://apiblueprint.org)