git-bug/webui/Readme.md

# git-bug rich web UI

## How to develop

### Run GraphQL backend

1. Download a git-bug stable binary.

2. Execute git-bug binary inside directory for the git repository it will manage issues:
   - git-bug webui -p 3001

### Run ReactJS front-end

1. Clone git-bug repository.

2. Enter webui directory and install libraries needed:
   - npm install

3. Generate ts code from graphql files and run webui in development mode
   - npm start
   - If You got compilation errors from lint, run lint command below and start again:
      - npm run lint -- --fix
      - npm start

The development version of the WebUI is configured to query the backend on the port 3001. You can now live edit the js code and use the normal backend.

## Bundle the web UI

Once the webUI is good enough for a new release, run `make pack-webui` from the root directory to bundle the compiled js into the go binary.
docs & cleaning 2018-09-16 14:50:53 +03:00			`# git-bug rich web UI`

			`## How to develop`

Commit for #557 - Adding more details - Tip when lint error occur 2021-02-09 00:44:18 +03:00			`### Run GraphQL backend`
webui: format some files 2020-02-13 01:39:23 +03:00
Commit for #557 - Adding more details - Tip when lint error occur 2021-02-09 00:44:18 +03:00			`1. Download a git-bug stable binary.`
webui: format some files 2020-02-13 01:39:23 +03:00
Commit for #557 - Adding more details - Tip when lint error occur 2021-02-09 00:44:18 +03:00			`2. Execute git-bug binary inside directory for the git repository it will manage issues:`
			`- git-bug webui -p 3001`

			`### Run ReactJS front-end`

			`1. Clone git-bug repository.`

			`2. Enter webui directory and install libraries needed:`
			`- npm install`

			`3. Generate ts code from graphql files and run webui in development mode`
			`- npm start`
Commit for #557 - Formatting 2021-02-09 00:48:44 +03:00			`- If You got compilation errors from lint, run lint command below and start again:`
Commit for #557 - Formatting 2021-02-09 00:47:00 +03:00			`- npm run lint -- --fix`
			`- npm start`
Commit for #557 - Adding more details - Tip when lint error occur 2021-02-09 00:44:18 +03:00
Commit for #557 - Formatting 2021-02-09 00:48:44 +03:00			`The development version of the WebUI is configured to query the backend on the port 3001. You can now live edit the js code and use the normal backend.`
docs & cleaning 2018-09-16 14:50:53 +03:00
			`## Bundle the web UI`

webui: format some files 2020-02-13 01:39:23 +03:00			Once the webUI is good enough for a new release, run `make pack-webui` from the root directory to bundle the compiled js into the go binary.