API for discovery of frequencies of Australia's FM & AM Radio Stations
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib/tasks
log
public
spec
storage
tmp
vendor
.coveralls.yml
.gitignore
.rspec
.rubocop.yml
.ruby-version
.travis.yml
Dockerfile
Gemfile
Gemfile.lock
Makefile
Procfile
README.md
Rakefile
config.ru
docker-compose.dev.yml
docker-compose.test.yml

README.md

FreqFinder

Build Status Yard Docs

Not finding freaks but freqs - radio frequencies for when you're out and about.

Why? Because while Australia's ACMA publishes some things, a simple "what radio is available near me?" response just doesn't exist! It was inspired when my girlfriend called me wanting to know the TripleJ frequencies near her!

GeoCode base stations (not taking into account power...yet) against a location and get going with options to listen to!

API Support

v1: JSON:API

Available at: https://freqfinder.herokuapp.com/v1/

  • Station https://freqfinder.herokuapp.com/v1/stations
  • Transmitter https://freqfinder.herokuapp.com/v1/transmitters

v2: GraphQL

Available at: https://freqfinder.herokuapp.com/v2/

Stations

query {
  allStations {
    edges {
      node {
        title
        id
      }
    }
  }
}

Transmitters

query {
  allTransmitters(location: "-33.88051,151.20948") {
    edges {
      node {
        frequency
        band
        distance
        station {
          title
        }
      }
    }
  }
}

Requirements

If you are developing locally, bust out your Docker so that.

Development

Docker makes life lovely here.

docker-compose -f docker-compose.dev.yml build web
docker-compose -f docker-compose.dev.yml up web
docker-compose -f docker-compose.dev.yml run web bundle exec rake db:drop
docker-compose -f docker-compose.dev.yml run web bundle exec rake db:create
docker-compose -f docker-compose.dev.yml run web bundle exec rake db:migrate
docker-compose -f docker-compose.dev.yml run web bundle exec rake db:seed

You should then be able to access the service at:

localhost:3000

Testing

Testing is also nice with Docker!

docker-compose -f docker-compose.test.yml build web
docker-compose -f docker-compose.test.yml up web
docker-compose -f docker-compose.test.yml run web bundle exec rake db:drop
docker-compose -f docker-compose.test.yml run web bundle exec rake db:create
docker-compose -f docker-compose.test.yml run web bundle exec rake db:migrate
docker-compose -f docker-compose.test.yml run web bundle exec rake db:seed
docker-compose -f docker-compose.test.yml run web bundle exec rspec