Skip to content

Commit f7034ca

Browse files
committed
Update readme
1 parent 45cd16f commit f7034ca

File tree

1 file changed

+18
-25
lines changed

1 file changed

+18
-25
lines changed

README.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,29 @@ and CI/CD.
55

66
# Gilded Rose Refactoring Kata
77

8-
Today's workshop is based on a popular refactoring exercise you can find out more about [here](https://github.com/emilybache/GildedRose-Refactoring-Kata/tree/main).
8+
Today's workshop is based on a popular refactoring exercise you can find out more about [here](https://github.com/emilybache/GildedRose-Refactoring-Kata/tree/main).
99

1010
# Setup
1111

1212
We recommend using [Intellij](https://www.jetbrains.com/idea/download/) as the IDE.
1313

14+
You might also have to install [nvm-windows](https://github.com/coreybutler/nvm-windows) if you are running on Windows.
15+
1416
You will have to install [Node](https://nodejs.org/en/download/package-manager) v18.20. This should also install `npm`,
15-
which is a Node packet manager
17+
which is a Node packet manager.
18+
19+
You don't need to run this in a virtual machine.
20+
21+
You might also have to install [ts-node](https://www.npmjs.com/package/ts-node#installation), after you get Node.
1622

17-
# Getting started
23+
```
24+
# Locally in your project.
25+
npm install -D typescript
26+
27+
npm install -D ts-node
28+
```
29+
30+
# Getting started
1831

1932
**First, fork this repository and clone it on your device.**
2033

@@ -38,11 +51,11 @@ To run all tests in watch mode:
3851

3952
You can run the application seeing how the `updateQuality()` function works:
4053

41-
```npm run app```
54+
```npx ts-node test/golden-master-text-test.ts```
4255

4356
Or with the number of days as args:
4457

45-
```npm run app 10```
58+
```npx ts-node test/golde-master-text-test.ts 10```
4659

4760
# Gilded Rose Requirements Specification
4861

@@ -81,23 +94,3 @@ for you).
8194

8295
Just for clarification, an item can never have its `Quality` increase above `50`, however __"Sulfuras"__ is a
8396
legendary item and as such its `Quality` is `80` and it never alters.
84-
85-
# Continuous Integration
86-
87-
Now that we've improved the codebase through a thorough refactor, and we've added some much-needed tests, it's time
88-
to think about taking advantage of those.
89-
90-
We'd like to only be able to merge code if the test suite passes, otherwise the PR should fail. This way we're never adding
91-
breaking changes. To do that, we're going to create a GitHub action to run the tests on Pull Request.
92-
93-
Start by looking in the [test.yml](.github/workflows/tests.yml) file.
94-
95-
1. Set the trigger to be when someone opens a PR against the `main` branch
96-
2. Create a `test` job that runs on ubuntu
97-
3. Firstly, we'd need to get the code - Hint: what are we doing when changing out a branch
98-
4. Secondly, we'd need to make sure the environment is set - Hint: we're using Node
99-
5. After we make sure we have the code and the environment set, we should install all dependencies and then run the tests.
100-
101-
102-
Stretch goal: Sometimes we're too lazy to check the status each time. It might be easier to receive an email. What should
103-
we do to make sure we're receiving an email whenever a build passes or fails?

0 commit comments

Comments
 (0)