Skip to content
CLI gem providing crime info from opendata.austintexas.gov
Branch: master
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.
bin
lib
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
NOTES.md
README.md
Rakefile
austin_crime.gemspec
spec.md

README.md

AustinCrime

AustinCrime is my first official project for Flatiron School. Built with Ruby, it is a CLI gem that allows users to view Austin crime reports by crime type. There's a running (somewhat truthful) joke about too many people moving to Austin. So, I decided to do my project based on that. I figured if I could write a gem showing how much crime we actually have, I could deter prospective citizens!

Thoughts

This was my first fully blank slate project since starting bootcamp, though not my first gem (that was TicTacToe with AI). I was extremely nervous about it - Object Oriented Ruby = a thorn in my side. I understood it, just couldn't explain it very well. But I was able to show I knew what I was doing and ultimately pass my first assessment. This was also the first time I started feeling like a "real" developer.

Installation

Add this line to your application's Gemfile:

gem 'austin_crime'

And then execute:

$ bundle

Or install it yourself as:

$ gem install austin_crime

Run from terminal with:

austin_crime

Usage

Run the gem and the program will provide you with 5 crime types. You can then type the number of the type you want to read more about and the terminal will display the one full result. If you want to view more, you can type 'more', and it will show you 10 full crimes. You can also type "List" to display the list of types again, or "q" to quit the program.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tracypholmes/austin_crime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.