JustTrampIt

Version 1.0

Plan your next tramping experience across New Zealand's extensive network of tramps, huts, and campsites with ease.
JustTrampIt brings together all the information you need to plan your next adventure.
It provides users with a map of tramps, huts, and campsites, planning tools, as well as a clear emergency guide, and cultural information.
This project was created as a part of the SENG202 course by team 1 at the University of Canterbury.

Requirements:

• Java 21 (JDK)
• Git

Steps:

1. Clone the repository

   • git clone https://eng-git.canterbury.ac.nz/seng202-2025/seng202-25-team1.git
   • Navigate to the repository

2. Get a map API key from ArcGIS

   • Go to https://location.arcgis.com/sign-up/
   • Sign up for an account
   • Click on content
   • Create a new item
   • Select developer credentials
   • Select API key credentials
   • Enable all services
   • Get your map API key

3. Get API key from DOC

   • Go to https://api.doc.govt.nz/
   • Sign up for an account
   • Subscribe to tracks, huts, campsites, and alerts
   • Click on your account
   • Get your API key

4. Get API key from OpenWeather

   • Go to https://openweathermap.org/full-price#current
   • Sign up for an account with the Forecast 16 days
   • Get your API key

5. Set your API keys

   • In the app/src/main/resources folder within the repository folder create a .env file
   • Inside this file write MAP_API_KEY=<your_map_api_key_here>
   • Inside this file write DOC_API_KEY=<your_doc_api_key_here>
   • Inside this file write WEATHER_API_KEY=<your_open_weather_api_key_here>
   • save the file and exit

6. Run the project

   • ./gradlew run

7. Optionally build a runnable JAR

   • ./gradlew jar
   • The artifact will be in app/build/libs/

If you have not built a runnable JAR, you can run the project with the ./gradlew run command. Otherwise, navigate to app/build/libs and run java -jar app.jar the application should load to the screen bellow.

After the data is loaded, the tutorial will open see below. This provides a basic walk through of the app and how to use it.

Once the tutorial is finished the main page is opened. Here you can set filters and search for tramps, huts, and campsites, seeing the results on the map, and the list view. If you wish to add your own track this is available through the add track button in the top right.

After your search parameters are set you can select locations by clicking on the map points or the list view. This will open a popup with some basic information, and display the track's route. With in the popup the locations can be saved by clicking the heart icon.

Once you have selected the data point on the map or in the list, the panning page become available. When you click planning in the navbar or the arrow in the popup, a new page will open with more details seen below. This is where you can begin to plan your adventure.

CONTRIBUTING.md

Distributed under the MIT License.