rapee / youpin-api

YouPin's API

YouPin API

API (dev environment): https://dev.api.youpin.city All data is sent and recieved as JSON.

API Documents

API Documents is auto-generated by apidoc and can be accessed at https://youpin-city.github.io/youpin-api-docs

Run

To run your local YouPin API,

1. Clone repo git clone [e-mail]:youpin-city/youpin-api.git.

2. Get credential GCS private key. Currently, YouPin API depends on Google Cloud Storage (GCS) to store photos and videos. Follow instruction 1.a to 1.f to get GCS private key. Rename the key to youpin_gcs_credentials.json and place it in the root folder (same level with package.json).

3. Install docker.

4. Start service with docker-compose up -d. The service will run on port 9100. To stop, run docker-compose stop. If you need to build a new docker image with modified code, run docker-compose up --build -d.

Changelog

0.1.0

• Initial release

License

Copyright (c) 2016

Licensed under the MIT license.