Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 4.11 KB

README.md

File metadata and controls

79 lines (63 loc) · 4.11 KB

Park Buddies

Note
Currently in the process of being refactored and overhauled to take advantage of new features on Flask.

Description

A web application to find National Parks to explore and find information about current operations. Started out as the Capstone project, but has since moved into a fun personal project.

park-buddies park-buddies park-buddies park-buddies park-buddies park-buddies park-buddies

Table of Contents (Optional)

Installation

Docker Compose

  1. Copy this repository and run the command: docker compose up
  2. This will build the images necessary to run this project.

Local Installation

  1. Clone this repository: git clone git@github.com:kev-odin/park-buddies.git
  2. Create a virtual environment: python3 -m venv venv
  3. Start venv: source venv/bin/activate
  4. Install project requirements: pip install -r flask-web/requirements.txt
  5. Run: python3 flask-web/app.py
  6. Open a web browser to this URL: localhost:5000

Usage

park-home

Tech Stack

Python JavaScript Docker Flask bootstrap github actions DigitalOcean

How to Contribute

If you are intrested in contributing to this project, feel free to create an issue, fork the repository, and create a pull request. If new features are added, write relevant unit and integration tests to ensure code coverage.

License

Park Buddies is licensed under the MIT License.