camply

(★ 645)

camply, the campsite finder ⛺️ - a tool to find campsites at sold out campgrounds through sites like recreation.gov

  • .gitignore
  • .pre-commit-config.yaml
  • .releaserc.json
  • Dockerfile
  • LICENSE
  • mkdocs.yml
  • pyproject.toml
  • README.md
  • Taskfile.yaml
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/juftin/camply

Downloads the entire project code from GitHub to your computer.

cd camply

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • pipx Installs Python-based CLI tools into isolated environments.
pipx install camply

Installs the CLI tool into an isolated environment via pipx.

After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t camply .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 camply

Runs the built image as an actual container.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly — no need to clone the source.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

If it runs without errors and prints output in the terminal, it worked.
// repository documentation