Skip to content

A simple yet informative website using the open source U.S. National Parks Service API.

License

Notifications You must be signed in to change notification settings

Kaushik612/national-parks-service

Repository files navigation


Logo

National Park Helper

A fun project built using the open source National parks service API

Forks Stargazers License

Table Of Contents

About The Project

A fun website to learn more about U.S. National parks using the National parks open sourced API's.

The idea behind building this website is to get a good understanding of how we can build fun project using an open source API.

This application is built using TypeScript, React Router DOM and TailwindCSS.

Built With

  • Vite
  • React
  • Tailwind
  • Typescript
  • FramerMotion

Features:

  • Tailwind design and Framer-motion animations
  • Fully Responsive
  • Page loading state
  • React Tanstack query for fetching data from API.
  • Beautiful dark and light mode components
  • How to reuse layouts

(back to top)

Getting Started

Prerequisites

Node version 18.x.x

Cloning the repository

git clone https://github.com/Kaushik612/national-parks-service.git

Install packages

npm install

Setup .env file

VITE_NPS_X_API_KEY=

Setup NPS API Developer Key

Please read the documentation here on how to generate the API key to use the National Parks Service API.

https://www.nps.gov/subjects/developer/get-started.htm

You will then need to update the ".env" file with your API key.

Start the app

npm run dev

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

Authors

Kaushik Ravikumar - Full Stack Web Developer - Kaushik Ravikumar