# Setting up the project
## Requirements
Copyright By PowCoder代写 加微信 powcoder
– JDK12+ aren’t supported by the course, but *should* work in the project build scripts we’ve setup, given that you don’t use any of the new features
– VSCode (Recommended) or IntelliJ
– Windows/MacOS/Linux
– CSE is supported through VLAB
– VSCode + SSH aren’t supported
– VSCode + WSL aren’t explicitly supported, but the setup we use should work for it, however there is no `xdg-open` command in WSL (but it exists in linux) so you’ll have to open the browser manually to the url `localhost:4568/app/` the `app/` part is important.
– Your project repository (which we’ll presume you’ll be okay with cloning and managing)
## How to open?
– You can open vscode and then go File -> Open (/Folder on MacOS) and select the folder `project` that you’ve cloned locally.
– *Make* sure you have just the project opened.
– `code project`
## How to run?
Firstly guarantee that the folder that you have opened is correct, you can see the default hierachy below, ensure that the name at the top says `project` if it doesn’t you don’t have the right folder opened :).
![image.png](./setup/vscode_hierachy.png)
Next, just locate the `app.java` file and click the run button on that file.
![image.png](./setup/vscode_run.png)
This will then synchronise your frontend with the current latest version and once that’s done (should be very quick) it’ll start the server.
## How to generate coverage reports?
You can generate coverage reports through the use of `gradle test`. This will generate both human readable ones (html) as well as more computer readable ones (xml) which an extension can read and show you inline coverage.
You can see inline coverage reports via; [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) which is a VSCode extension. An example of this is shown below.
![image.png](./setup/vscode_gutters.png)
> isn’t that pretty 😀
If they aren’t showing up for you make sure that the bottom left “Coverage” button is showing something like `X% coverage` (just informs about current opened file). If it isn’t just click it!
![image.png](./setup/vscode_coverage.png)
## How to test?
You can either run `gradle test` or a bit more nicely go to the test file and click the run test button that’ll appear to the left of the icon.
![image.png](./setup/vscode_test.png)
> How to debug tests? You just have to right click and then debug test.
## Resources
For running the frontend locally and running your JUnit tests on VSCode, you will need to place your dungeons and configurations inside `src/main/resources/`. If you want your resources to be accessible via **Gradle** then you will need to put them in `src/test/resources`.
The `FileLoader` class we have provided you with will load the resources from the correct directory automatically.
程序代写 CS代考 加微信: powcoder QQ: 1823890830 Email: powcoder@163.com