version 0.1.0

How To Start Service

Installation

1. Install Docker
2. Clone repository

git clone git@github.com:Wikimedia-TW/wiki-awareness-backend.git

3. Install required packages

cd wiki-awareness-backend
docker run --rm -v $(pwd):/app composer install

4. Change file owner to current user

sudo chown -R $USER:$USER ~/wiki-awareness-backend

5. Config .env and set up GCP project credential file

mv .env.example .env
mkdir service
mv g0v-wiki-awareness-e81bff7c6201.json ~/wiki-awareness-backend/service/.

Starting Service

docker-compose up -d

docker-compose exec app php artisan migrate:install

Note. Only need to be executed at the first time.

docker-compose exec app php artisan migrate

Note. Only need to be executed once for every version.

Stoping Service

docker-compose down

Task Lists

• Creating a report
• Connecting reports to Google sheets

APIs Description

Reports

1. Creating a new report

POST localhost/api/reports

key	validation
fingerprint	string | required | 255
url	string | required | 255
highlighted	string | required | 255
description	string | 255
type	string | required | 12

Response Example

Status 201

2. Getting all reports(disabled)

GET localhost/api/reports