api

Pisspricer Web API

A Node.js Express web api used for Pisspricer. The api is currently deployed at pisspricer.co.nz/api/v1.

Requirements

• Node.js
• npm

Install / Setup

1. Clone the repository.

   git clone https://github.com/TooMuch4U/pisspricer-api

2. Install npm dependencies.

   # Change into the src directory
   cd api
   
   # Install npm dependencies
   npm install

3. Set the following environment variables.

   EMAIL_HOST=
   EMAIL_USER=
   EMAIL_PASSWORD=
   EMAIL_ADDRESS=
   CLOUD_SQL_CONNECTION_NAME= //see https://cloud.google.com/sql/docs/mysql/connect-app-engine-standard
   
   MYSQL_HOST=localhost
   MYSQL_USER=root
   MYSQL_PASSWORD=password
   MYSQL_DATABASE=pisspricer
   MYSQL_PORT=3306
   IMAGE_BUCKET=images.pisspricer.co.nz
   BUCKET_KEY_PATH=/config/Pisspricer.json
   OPEN_PORT=4941
   

HTTPS

To enable https aswell as http...

1. Set an OPEN_PORT_HTTPS environment variable to the desired https port.
2. Place the ssl certificate named cert.pem and the key named key.pem in the directory (/api).

Usage

Start the api server with

npm start

Testing

A testing environment can be set up as described in the corresponding README files in /testing-env.

Docker Usage

Populate container with previous data

Export data: mysqldump -u root -p --databases pisspricer --routines > dump.sql

(optional) SCP mysqldump from gcloud compute instance: gcloud beta compute scp --zone "us-west1-b" --project "pisspricer" "instance-1":/containers/api/populate-data/dump.sql .

Move the dump.sql into the ./populate-data directory.

Start the docker container: sudo docker-compose up -d

Connect to the containers shell: sudo docker exec -it api_db_1 bash

Populate the data (takes 20 seconds): mysql -p < populate-data/dump.sql

Environment

A .env needs to be created in the Docker directory.

A gcloud json key needs to be provided in the ./keys and specified in the .env file.