diff --git a/readme.md b/readme.md index 6b566f0..f759b5b 100644 --- a/readme.md +++ b/readme.md @@ -4,7 +4,7 @@ This is a super simple API I created using Spring Boot/Gradle to showcase what a Once your editor or IDE finishes setting up this container, you can test out the API by navigating to [localhost:8080/sum](http://localhost:8080/sum). You will need to provide two integer parameters and, as the endpoint name suggests, the API will return their sum. -### Setup - VS Code +## Setup - VS Code 0. Ensure you have the following extension installed: `ms-vscode-remote.remote-containers` (copy-paste that into extension search). @@ -13,7 +13,7 @@ Once your editor or IDE finishes setting up this container, you can test out the 1. It should be sufficient to simply open this project in VS Code. -### Setup - IntelliJ +## Setup - IntelliJ 1. In the welcome screen, navigate to Remote Development > Dev Containers. @@ -22,9 +22,10 @@ Once your editor or IDE finishes setting up this container, you can test out the 2. Click on "New Dev Container" and either a. Paste the link to this repository + b. Go to the "From Local Project" tab and give IDEA the path to this project's `devcontainer.json` file. -### Running the Application +## Running the Application To run the application, navigate to `CalculatorApplication.java` and click the run button in the top right, or go to the Spring Boot Dashboard and click the run button there. @@ -39,7 +40,7 @@ To run the application, navigate to `CalculatorApplication.java` and click the r will return 100 + 12 = 112. -## About Docker Devlopment Containers +# About Docker Devlopment Containers Dev containers will allow our team to maintain a consistent development environment across members and platforms. While this is nice, it comes at the cost of (slightly) higher CPU, memory, and disk usage. @@ -48,7 +49,7 @@ Both VS Code and IntelliJ IDEA support dev containers, with the former having a > [!IMPORTANT] > Cross IDE development is definitely possible, since IDEA (Ultimate) already comes bundled with everything VS Code would require an extension for. -### Disk Usage +## Disk Usage In my testing, I've observed the following: