https://github.com/raistlfiren/run812

A curated list of running routes pulled from an API, Ride With GPS, and displayed on a simple website. The goal is to provide a collection of routes with their cue sheets for easy access.
https://github.com/raistlfiren/run812

cuesheet docker-compose leaflet mysql php ridewithgpsapi routes run symfony

Last synced: 10 days ago
JSON representation

A curated list of running routes pulled from an API, Ride With GPS, and displayed on a simple website. The goal is to provide a collection of routes with their cue sheets for easy access.

• Host: GitHub
• URL: https://github.com/raistlfiren/run812
• Owner: Raistlfiren
• Created: 2021-06-17T12:41:49.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T23:39:49.000Z (about 1 year ago)
• Last Synced: 2023-10-19T00:29:42.255Z (about 1 year ago)
• Topics: cuesheet, docker-compose, leaflet, mysql, php, ridewithgpsapi, routes, run, symfony
• Language: PHP
• Homepage: https://812.run
• Size: 5.04 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Run 812 Routes

This is a "simple" application to organize running routes in the tristate area. 

It uses PHP, Symfony as the framework, for the backend and Bootstrap for the frontend. 

The Javascript is vanilla. The website fetches routes from Ride With GPS.

[![Symfony](https://github.com/Raistlfiren/run812/actions/workflows/test.yml/badge.svg)](https://github.com/Raistlfiren/run812/actions/workflows/test.yml)

## Homepage

![Homepage](./screenshots/homepage.jpg)

## Route View

![Route View](./screenshots/route_view.jpg)

## Route Collection View

![Route Collection View](./screenshots/route_collection_view.jpg)

## PDF View

![PDF View](./screenshots/pdf_view.jpg)

Currently, the application can do the following:

- Fetch routes from Ride With GPS

- Store those routes in a database

- Display routes in a simple and easy to use view

  - Filter routes by location, name, or distance

  - View routes and collections of routes

  - View a thumbnail of the route

  - See next scheduled route on the homepage

- Display individual routes

  - Display mile markers on routes

  - Display directions on routes

  - Export the cue, direction, sheet to a PDF for easy printing

  - Export the route to a GPX file to import into your watch or other program

  - View the route on Open Street Maps

- Manage events, route collections, locations, and fetch a new data set of routes from Ride With GPS

  - Events can be created with a route collection to display on the homepage

  - Route collections are a collection of similar routes that vary in distance

  - Locations are just general locations for filtering routes on the view all routes page

## Running the program

Docker is the recommended way of running the program on your local computer. 

Current requirements:

- PHP 8.1

- MySQL Database

- `.env` needs to be copied to `.env.local` and values need to be updated

### Helpful commands

`docker-compose up` - Runs the `docker-compose.yaml` file and generates the environment

It consists of PHP 8.1, Nginx, and MySQL

`docker-compose run encore npm install` - Installs npm dependencies

`docker-compose run encore npm install --save ` - Installs package to package.json

`docker-compose run encore npm run watch` - Builds JS dependencies and watches for changes

`docker-compose run encore npm run build` - Builds everything for PROD or live environment

#### After docker-compose up...

`docker-compose exec php composer require ` - to install a dependency

`docker-compose exec php ./vendor/bin/phpunit` - Run tests

`XDEBUG_MODE=coverage docker-compose exec php ./vendor/bin/phpunit --coverage-html html` - Run phpunit tests and generate =code coverage

*xdebug.ini* will need to be updated with `xdebug.mode=coverage` 

`docker-compose exec php ./bin/console ...` - Execute Symfony console commands

`docker-compose exec php ./bin/console routes:download` - Download and store all the routes from Ride With GPS. This requires a valid login and API access.

`docker-compose exec php ./bin/console user:create  ` - Creates a new user in the database