From 4f645442a7147df989d7f86ab5caa85605b0c350 Mon Sep 17 00:00:00 2001 From: nofurtherinformation Date: Thu, 22 Aug 2024 10:11:04 -0500 Subject: [PATCH] readme and cleanup macos --- README.md | 18 ++++++++++++++++++ setup-macos.sh => setup-macos.command | 0 2 files changed, 18 insertions(+) rename setup-macos.sh => setup-macos.command (100%) diff --git a/README.md b/README.md index 229a9a2..d2f5782 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ +## Beginner Quickstart +If you simply want to run the application or use the visual interface to edit content, use the following to get started: + +*On windows:* +- Double click `setup-windows.bat` in the base folder for the project +- Enter the `DATA_ENDPOINT` and `NEXT_PUBLIC_MAPBOX_TOKEN` provided from the project team. For non-affiliated users, see data requirements below. +- Open your web browser and navigate to `localhost:3000` to view the website, and `localhost:3000/admin/index.html` for the content editor. + +*On macos:* +- Open the terminal and navigate to the project. You may want to use Github Desktop, then clicked "Repository" > "Open in Terminal" +- Run the following command in the terminal: +``` +chmod a+x setup-macos.command +``` +- Double click `setup-macos.command` +- Enter the `DATA_ENDPOINT` and `NEXT_PUBLIC_MAPBOX_TOKEN` provided from the project team. For non-affiliated users, see data requirements below. +- Open your web browser and navigate to `localhost:3000` to view the website, and `localhost:3000/admin/index.html` for the content editor. + ## Quickstart `docker build --platform=linux/amd64 -t rgdv-app .` diff --git a/setup-macos.sh b/setup-macos.command similarity index 100% rename from setup-macos.sh rename to setup-macos.command