Olympic Coast Treks

The olympic-coast-treks package provides a frontend and backend for planning multi-night backpacking treks along the the Olympic Coast in Washington, taking into account route information, tide levels, tidal restrictions, and sunrise and sunset times.

Planning routes

Use the deployed web app (https://olympic-coast-treks.web.app) to plan routes.

Disclaimer

While this tool is designed to assist with planning, it is not intended to be a replacement for more detailed analysis on the part of the hiker. Any route suggestions provided should be checked against the latest maps, tide tables, and any information provided by Olympic National Park, the Ozette Indian Reservation, and the Makah Reservation.

Refer to the software license for information about use and liability.

Backend development

We recommend using uv.

Clone the package locally

git clone https://github.com/pjireland/olympic-coast-treks.git

Then navigate to the backend subdirectory within olympic-coast-treks.

Set up environment

From within the backend subdirectory:

uv sync

Run unit tests

From within the backend subdirectory:

make test

Run style checks and fixes

From within the backend subdirectory:

make style

Starting a local API

From within the backend subdirectory:

make api

API docs can be then be accessed via http://localhost:8000/docs.

Frontend development

npm is needed to serve the frontend. We recommend using the Node Version Manager (nvm) to install npm. Directions for installing nvm are available here.

Once npm is installed, call npm run dev from within the frontend subdirectory to serve the frontend locally. Note to make API calls from the front end, you'll need to also have a local API running, per the earlier directions.