hawk.so

Hawk 2.0 web client

How to run

Development

1. Create .env file (use .env.sample for example).
2. Run yarn install to install all dependencies.
3. Run yarn serve to run dev server.

Production

1. Create .env file (use .env.sample for example).
2. Run yarn install to install all dependencies.
3. Run yarn build to build the app.
4. Run yarn serve:prod to run simple production server.

Docker

1. Build image from Dockerfile: docker image build . -t hawk_garage
2. Run container: docker run -it -p 8080:8080 --rm hawk_garage

Storybook

Storybook is a components explorer. It is used to explore components UI and behaviour and to develop them in isolation.

To add story, create a folder for component in src/storybook/stories. In a folder create .ts file for story and .mdx file for story docs.

To run storybook, use yarn storybook command

Useful commands

1. yarn lint:js - runs eslint to check files with .js and .vue extensions.
2. yarn lint:css - runs stylelint to check files with .css and .vue extensions.
3. yarn lint - runs both eslint and stylelint.

Load GraphQL schema for development

After updating Hawk GraphQL API scheme you should pull its schema (see file) for code highlighting and typechecking in queries.

Run yarn get-schema to load schema from local server

License

Source code is available under Business Source License 1.1 (BSL 1.1). See LICENSE for terms, including: