Sixty-Three

U.S. National Park tracker application that allows users to track which of the 63 National Parks they've been to, earn milestone badges associated with the parks, and make posts and reviews based on their experiences.
Explore the code »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

U.S. National Park tracker application that allows users to track which of the 63 National Parks they've been to, earn milestone badges associated with the parks, and make posts and reviews based on their experiences.

(back to top)

Built With

• Express
• MongoDB

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

MongoDB or and Mongo DB Atlas repository must be configured, and an API key must be obtained for the National Parks API (this is free).

Installation

1. Clone the repo

   git clone https://github.com/hcduffey/SixtyThree.git

2. Install dependencies

   npm i

3. Configure your .env file with a Mongo DB URI, NPS API key, and a secret for use in signing sessions.

4. Run node

   node server.js

(back to top)

Usage

Once you sign up for an account, you can navigate to the Parks section to look at the details of individual parks. If you've been to the Park, you can add the Parks badge to your profile from the Park details page. You can also then leave a review of the park.

The Users section allows you to view other users profiles. This allows you to see the parks they have visited and reviews they've left.

(back to top)

ER Diagram

Wireframe

MVP Goals

• As a user, I want to be able to login and see my parks visited/badges and associated reviews on my profile page
• As a user, I want to be able to collect milestone badges and review parks that I have been to
• As a user, I want to be able to see all of the parks on one page, linked with their associated show pages that display park info and reviews
• As a user, I want to be able to view other user profiles

Stretch Goals

• As a user, I want to be able to see an interactive map of all the parks with pins that lead to each individual park
• As a user, I want to be able to interact with and search for other users
• As a user, I want to be able to have a customizable profile picture
• As a user, I want to be able to see my favorite park and reflections/highlights on my profile page

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Acknowledgments

• National Parks API
• Google Fonts
• Best-README-Template

(back to top)