From 317f9f2938a5b30e127e391b0a49d5b819b438b9 Mon Sep 17 00:00:00 2001 From: Kyle Shores Date: Tue, 13 Aug 2024 10:27:10 -0500 Subject: [PATCH] updating readme --- .gitignore | 3 +++ README.md | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/.gitignore b/.gitignore index 104b544..b269e90 100644 --- a/.gitignore +++ b/.gitignore @@ -482,3 +482,6 @@ $RECYCLE.BIN/ # Vim temporary swap files *.swp + +obj +bin \ No newline at end of file diff --git a/README.md b/README.md index f47df69..db14b6f 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,26 @@ API for the Chemistry Cafe web application found here https://github.com/NCAR/ch # Getting Started +## Command line + +Install the `dotnet` tool + +### macOS + +``` +brew install dotnet +``` + +--- + +Then build the project + +``` +dotnet run +``` + +This should start a server. You should be able to access a swagger page on the port that the server stars, for example [http://localhost:5134/swagger](http://localhost:5134) + ## Installing the API locally To build and install Chemistry Cafe locally, you must have Visual Studio 2022.