Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Housekeeping: Markdownlint #905

Merged
merged 19 commits into from
Feb 24, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix linter issues in ui readme
  • Loading branch information
lovromazgon committed Feb 23, 2023
commit f9bb9ba5d74b1658337d28c1da6863cdb9b27ccf
13 changes: 9 additions & 4 deletions ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Conduit UI is the web front-end for Conduit built with [Ember](https://emberjs.c

## Architecture

The UI application is a standard Ember application that is simply rooted in the `ui` directory of the Conduit project. The UI can then be built and embedded into Conduit's binary during a Conduit build.
The UI application is a standard Ember application that is simply rooted in the `ui` directory of the Conduit project.
The UI can then be built and embedded into Conduit's binary during a Conduit build.

## Prerequisites

Expand All @@ -21,7 +22,8 @@ You will need the following things properly installed on your computer.
- `cd conduit`
- `make ui-dependencies`

_Note:_ Commands in this readme are run from the Conduit project root. Alternatively, you can change into the `ui/` directory to directly use Yarn, [Ember CLI](https://ember-cli.com/), or non-prefixed [UI Makefile](Makefile) commands
_Note:_ Commands in this readme are run from the Conduit project root. Alternatively, you can change into the `ui/`
directory to directly use Yarn, [Ember CLI](https://ember-cli.com/), or non-prefixed [UI Makefile](Makefile) commands.

## Running / Development

Expand All @@ -44,16 +46,19 @@ After confirming that Conduit server is running locally, you can now run the UI
- `make ui-test`

### Linting

- `make ui-lint`
- `make ui-lint-fix`

### Building Conduit UI

Conduit UI is built and embedded into the server's binary using [Go embed directives](https://pkg.go.dev/embed). To build the binary with the embedded UI
Conduit UI is built and embedded into the server's binary using [Go embed directives](https://pkg.go.dev/embed). To
build the binary with the embedded UI

- `make build-with-ui`

This will build the production UI asset bundle, output it to `pkg/web/ui/dist`, and build the server binary embedded with the bundle.
This will build the production UI asset bundle, output it to `pkg/web/ui/dist`, and build the server binary embedded
with the bundle.

## Further Reading / Useful Links

Expand Down