diff --git a/README.md b/README.md index d2f5782..07e82cf 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ ## 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:* +_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:* +_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` + +- Double click `setup-macos.command`. The first time you run the set up script, you may receive an error that the app/script is from an unknown or unidentified developer. To run it anyways, control-click and choose "Open" from the shortcut menu -- you'll see an additional option to run it and in the future you can simply double click it. - 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. diff --git a/setup-macos.sh b/setup-macos.command similarity index 100% rename from setup-macos.sh rename to setup-macos.command