Skip to content

Files

Latest commit

aqsyonaslmangani
aqsyonas
and
lmangani
corrected JWT token port in README (#138)
May 22, 2019
91e5fc5 · May 22, 2019

History

History
68 lines (56 loc) · 2.38 KB

README.md

File metadata and controls

68 lines (56 loc) · 2.38 KB

Development documentation

Node Requirments

  1. Install NVM curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.8/install.sh | bash
  2. Restart terminal
  3. Get the current Homer-App node version cat homer-app/.node_version
  4. Install a matching node version accordingly, for example nvm install 8.9.1

Build Requirements

  1. Install Postgres >= 10
    • Create new user and database
sudo su - postgres
createuser homer --pwprompt
createdb -O homer homer_config
createdb -O homer homer_data
psql
postgres=# GRANT ALL PRIVILEGES ON DATABASE "homer_config" to homer;
postgres=# GRANT ALL PRIVILEGES ON DATABASE "homer_data" to homer;

* Configure database connection parameters in `server/config.js` (API)
* Make sure you use the correct db `connection` in `knexfile.js` (Provisioning)
  1. Install the Homer-App
    • npm install && npm install -g knex eslint eslint-plugin-html eslint-plugin-json eslint-config-google
  2. Provision migrations and defaults to database:
knex migrate:latest
knex seed:run
  1. Build app bundle by webpack
    • npm run build
  2. Start app
    • npm start or start in the development mode npm run dev
WARNINGS!
  • Check the seeds folder to avoid overwriting or dropping existing data.
  • Do not edit or eleminate existing migrations. If you need to change/add database schema - create a new knex migration.

API

Authentication

JWT Web Tokens are used to secure API. JWT settings are in src/private/jwt_settings.json.

First, get JWT token.

curl -X POST localhost:80/api/v3/auth \
-d "username=admin&password=password"

You will receive a message similiar to the following one:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRyZXgiLCJzY29wZSI6ImYwM2VkZTdjLWIxMjEtNDExMi1iY2M3LTEzMGEzZTg3OTg4YyIsImlhdCI6MTUwNzUzMDc1OSwiZXhwIjoxNTA3NTM0MzU5fQ.iDkeBJfPfj-MYGdbZDZJrzuTZOcQjRKM5Qi3SxmcBts",
  "scope":"f03ede7c-b121-4112-bcc7-130a3e87988c"
}

This token should be included in every API request, in the header section. It will expire in 1 hour; you can set the expire value in jwt_settings.json.

General

Widget development