Skip to content

Commit

Permalink
Fix the wrong side headings
Browse files Browse the repository at this point in the history
  • Loading branch information
josephspurrier committed Mar 24, 2020
1 parent 3ae553b commit a360e20
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is a sample notepad application that uses Vue on the front-end (UI) and Go

![Demo gif](https://user-images.githubusercontent.com/2394539/76177148-ac753e00-6189-11ea-963b-bff38b29e8ed.gif)

## Quick Start Guide (QSG)
## Quick Start with Docker Compose

To run the application locally, you can run these commands. You don't need any of the the dev tools (Go/npm) installed, you only need Docker (and Docker Compose). The ingress container is a reverse proxy that allows you to use a single URL to access multiple different docker containers depending on the URL.

Expand Down
16 changes: 11 additions & 5 deletions docs/docs/tutorial/env-prep.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ title: Environment Prep

Once you have cloned the repo, you will need the following tools for local development.

### Go
## Go

You should use Go 1.11 or newer. We recommend [gvm](https://github.com/moovweb/gvm) for installing and managing your versions of Go.

All of the commands below assume you have your `GOPATH` set to the root of the project directory. This is by design because we found (after many projects) it is much easier for you to clone the repo and make changes without having to rewrite imports if they are all contained within the project.

### Node and npm
## Node and npm

You should install [NodeJS and npm](https://nodejs.org/).

Expand All @@ -23,15 +23,15 @@ These are the current versions on the front-end components:
- Bulma [v1.2.7](https://www.npmjs.com/package/@nuxtjs/bulma/v/1.2.7) - [docs](https://bulma.io/documentation/)
- Swagger UI [v3.25.0](https://github.com/swagger-api/swagger-ui/releases/tag/v3.25.0) - [docs](https://swagger.io/tools/swagger-ui/)

### Visual Studio Code (VSCode) Setup
## Visual Studio Code (VSCode) Setup

You can use any IDE, but here is what you need for VSCode. It was quite a challenge getting ESLint to work properly when the .eslintrc.js file is not in the root of the project - the trick was the "eslint.workingDirectories" setting. All the settings are included in the .vscode/settings.json file. I use VSCode open only to the root of the project with no other projects. I recommend the following VSCode extensions:

- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Go](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go)
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur)

### Environment Variables
## Environment Variables

You can also use [direnv](https://direnv.net/) which sets your environment variables based on your current directory. For instance, you can install direnv, create a file in the root of this project called `.envrc`, and paste in the following:

Expand All @@ -46,7 +46,9 @@ export PATH=$PATH:$(npm bin)

Save the file and type `direnv allow`. That will automatically set environment variables when you `CD` into the project root and child folders.

## Getting Started with Development
## Makefile Commands

### Start Services

You can run these commands from different terminals to start the services.

Expand All @@ -67,6 +69,8 @@ make doc-dep
make doc-dev
```

### Database Control

These are other database commands you can use:

```bash
Expand All @@ -83,6 +87,8 @@ make db-reset
make db-rm
```

### UI and API Tests

Run tests for UI:

```bash
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/tutorial/run-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: run-locally
title: Run Locally
---

## Quick Start with Docker Compose

To run the application locally, you can run these commands. You don't need any of the the dev tools (Go/npm) installed, you only need Docker (and Docker Compose). The ingress container is a reverse proxy that allows you to use 1 URL to access 2 different docker containers by URL path.

```bash
Expand Down

0 comments on commit a360e20

Please sign in to comment.