API Development Process

This project is based on Nest.js.

To start developing, you need at least three things:

Install the dependencies
Configure a local database
Run the app

These three steps are covered in sequence below.

Installation

# install the dependencies of this project
npm install

# for the migrations (more on that below)
npm i -g ts-node

The Database (PostgreSQL)

Creating a local database with Docker:

docker run --name digituz-dashboard-postgres \
    -p 5432:5432 \
    -e POSTGRES_DB=digituz-dashboard \
    -e POSTGRES_USER=digituz-dashboard \
    -e POSTGRES_PASSWORD=123 \
    -d postgres:12.3-alpine

docker stop digituz-dashboard-postgres
docker rm digituz-dashboard-postgres

Restoring Production Database

To copy the backup, you can issue the following command:

docker rm -f digituz-dashboard-postgres

docker run --name digituz-dashboard-postgres \
    -p 5432:5432 \
    -e POSTGRES_DB=digituz-dashboard \
    -e POSTGRES_USER=digituz-dashboard \
    -e POSTGRES_PASSWORD=123 \
    -d postgres:12.6-alpine

docker exec -i -t digituz-dashboard-postgres /bin/bash

PGPASSWORD=spbGskUwcgv6RuNqJrcn3KqMqj pg_dump \
    --host=databases.digituz.com.br \
    --port=7432 \
    --username=digituz-db-user \
    --dbname=digituz > digituz.sql

psql \
    --username=digituz-dashboard \
    --dbname=digituz-dashboard \
    --file=digituz.sql

Running the app

First, you will need to create a .env file:

#################################
# these are development variables
#################################

NODE_ENV=development

# database variables
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_NAME=digituz-dashboard
DATABASE_USER=digituz-dashboard
DATABASE_PASSWORD=123

# upload variables
UPLOAD_DESTINATION=/tmp/uploaded-files

# aws s3 variables
AWS_S3_KEY=AKIAYIYZLUAN3XZHV4HP
AWS_S3_SECRET=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
AWS_S3_BUCKET=arquivos-dev.fridakahlo.com.br

# kraken api
KRAKEN_API_KEY=0edf80f7430c6e67cc906a03506a44b2
KRAKEN_API_SECRET=afbf70cac7b5750fca7d98fa4ea1f2c6c4203a09

# jwts
JWT_SECRET=12a31b23c44d41e23
JWT_TIME_SPAN=1d

# bling
BLING_APIKEY=50c467c88f5cb2b8021c7f8818a8d4b22df7a80dc29fbe1f533b0ce6c2e1cfaa7581fbc8

# typeorm (for migrations only)
TYPEORM_USERNAME=digituz-dashboard
TYPEORM_PASSWORD=123
TYPEORM_DATABASE=digituz-dashboard
TYPEORM_CONNECTION=postgres
TYPEORM_URL=postgres://digituz-dashboard:123@localhost:5432/digituz-dashboard
TYPEORM_SYNCHRONIZE=false
TYPEORM_MIGRATIONS_TABLE_NAME=database_migrations
TYPEORM_MIGRATIONS=src/db-migrations/*.ts
TYPEORM_MIGRATIONS_DIR=src/db-migrations

#shopify
SHOPIFY_NAME=digituz-shopfy
SHOPIFY_API_KEY=3064dee4738a01adbb4d46cecf3426a4
SHOPIFY_PASSWORD='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'
SHOPIFY_LOCATION_ID=57328992418

Then, you can run as follows:

# development
npm run start

# watch mode
npm run start:dev

# production mode
npm run start:prod

Database Migrations

You need to run the migrations after creating a database:

cd api
ts-node ./node_modules/typeorm/cli.js migration:run

Querying the Database Directly

Connecting to the database:

# getting inside the docker instace
docker exec -i -t digituz-dashboard-postgres /bin/bash

# from within the docker instance, connect to the databse
psql --user digituz-dashboard digituz-dashboard

# run your queries
select * from product;

# (danger) clean up table
truncate table product;

Authentication

# sign in
curl -X POST http://localhost:3005/v1/sign-in -d '{"username": "bruno.krebs@fridakahlo.com.br", "password": "lbX01as$"}' -H "Content-Type: application/json"

# copy the token from the command above
JWT=eyJ...Zxk

# use the token on other requests
curl -H 'Authorization: Bearer '$JWT localhost:3005/v1/profile

Interacting with the API

Using the API. For the moment, they all need JWTs. So, check the instructions above, then execute the following commands:

curl -H 'Authorization: Bearer '$JWT localhost:3005/v1/products

curl -X POST -H 'Authorization: Bearer '$JWT -H 'Content-Type: application/json' -d '{
  "sku": "LFK-0001",
  "title": "Máscara Frida Kahlo"
}' localhost:3005/v1/products

curl -X POST -H 'Authorization: Bearer '$JWT -H 'Content-Type: application/json' -d '{
  "parentSku": "LFK-0001",
  "sku": "LFK-0001-K",
  "description": "Kids"
}' localhost:3005/v1/products/variations

curl -X POST -H 'Authorization: Bearer '$JWT -H 'Content-Type: application/json' -d '{
  "parentSku": "LFK-0001",
  "sku": "LFK-0001-K",
  "description": "4 Kids"
}' localhost:3005/v1/products/variations

curl -X POST -H 'Authorization: Bearer '$JWT -H 'Content-Type: application/json' -d '{
  "parentSku": "LFK-0001",
  "sku": "LFK-0001-M",
  "description": "4 Men"
}' localhost:3005/v1/products/variations

curl -X POST -H 'Authorization: Bearer '$JWT -H 'Content-Type: application/json' -d '{
  "parentSku": "LFK-0001",
  "sku": "LFK-0001-W",
  "description": "4 Women"
}' localhost:3005/v1/products/variations

API Test

To create the test database, run the following commands:

CREATE DATABASE "digituz-dashboard-test";
GRANT ALL PRIVILEGES ON DATABASE "digituz-dashboard-test" TO "digituz-dashboard";

Then, execute the following command to run the migrations:

npm run migrate-tests

After that, you are ready to run tests:

npm run test

brunokrebs/dashboard-api