Skip to content

Commit 687020b

Browse files
authored
Fix the README for rest-api. (exercism#1832)
1 parent 0287bbd commit 687020b

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

exercises/rest-api/README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Rest Api
2+
13
Implement a RESTful API for tracking IOUs.
24

35
Four roommates have a habit of borrowing money from each other frequently, and have trouble remembering who owes whom, and how much.
@@ -35,4 +37,29 @@ Your task is to implement a simple [RESTful API](https://en.wikipedia.org/wiki/R
3537
- https://restfulapi.net/
3638
- Example RESTful APIs
3739
- [GitHub](https://developer.github.com/v3/)
38-
- [Reddit](https://www.reddit.com/dev/api/)
40+
- [Reddit](https://www.reddit.com/dev/api/)
41+
## Setup
42+
43+
Go through the setup instructions for Java to install the necessary
44+
dependencies:
45+
46+
[https://exercism.io/tracks/java/installation](https://exercism.io/tracks/java/installation)
47+
48+
# Running the tests
49+
50+
You can run all the tests for an exercise by entering the following in your
51+
terminal:
52+
53+
```sh
54+
$ gradle test
55+
```
56+
57+
In the test suites all tests but the first have been skipped.
58+
59+
Once you get a test passing, you can enable the next one by removing the
60+
`@Ignore("Remove to run test")` annotation.
61+
62+
63+
## Submitting Incomplete Solutions
64+
It's possible to submit an incomplete solution so you can see how others have
65+
completed the exercise.

0 commit comments

Comments
 (0)