Skip to content

Commit a6b1baa

Browse files
committed
update setup instructions
1 parent 592d23b commit a6b1baa

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

PREREQUISITES.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -105,18 +105,21 @@ http://editor.swagger.io/#/
105105
Recommended
106106
-----------
107107

108+
In order to test the API implementation locally, you should have a tool for
109+
making HTTP requests. You are free to use any tool you are comfortable with. We
110+
recommend Postman for this purpose if you don't have a strong preference.
111+
108112
### Postman
109-
In order to test your local application you should have a tool for performing HTTP requests.
110-
You are free to choose any tool you find comfortable and we recommend using [Postman](https://www.getpostman.com/)
111113

112-
If you choose to use Postman download the version for your OS from the above link. A handy option is
113-
to use the Chrome extension.
114-
After downloading and installing Postman if this is your first time using the tool we recommend
115-
getting familiar with at least these two guides:
114+
Postman can be installed as a native application or a Chrome plugin.
115+
116+
Get Postmane here: [Download Postman](https://www.getpostman.com/)
116117

117-
[requests](https://www.getpostman.com/docs/requests)
118+
If this is your first time using Postman, we recommend using these guides in
119+
order to get familiar with the tool:
118120

119-
[collections](https://www.getpostman.com/docs/collections)
121+
- [requests](https://www.getpostman.com/docs/requests)
122+
- [collections](https://www.getpostman.com/docs/collections)
120123

121-
Some of the exercises will contain a file named postman_collection and those will help you complete
122-
the exercise more quickly.
124+
Some of the tutorial lesson directories contain a file named
125+
`postman_collection`. These will help you complete the exercises more quickly.

VM.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ You can check the status of the VM by running `vagrant status` from within
1111
the repo directory. If it is not already running, start it with
1212
`vagrant up --provider virtualbox`.
1313

14+
### Keep Up-to-Date
15+
16+
On the day of the tutorial, make sure to `git pull` the latest updates to the
17+
repo and then run `vagrant provision` in order to make sure the VM has the
18+
latest updates.
19+
1420
### Logging In
1521

1622
You can log in to the VM using `vagrant ssh` on the command line or by
@@ -25,6 +31,13 @@ start it again using the commands above.
2531
VM Tools
2632
--------
2733

34+
### Shared Directory
35+
36+
Vagrant is configured to map this repo directory to a directory called
37+
`tutorial-repo` in the ssh user's home directory. This will allow you to edit
38+
files on your host machine using your preferred editor while also being able
39+
to edit and validate them while logged-in via ssh.
40+
2841
### Swagger Editor
2942

3043
Two versions of the web-based [swagger-editor](https://github.com/swagger-api/swagger-editor)

0 commit comments

Comments
 (0)