Welcome to the FBI 50 Most Wanted CLI!
This project was created by two students attending Flatiron School's software engineering immersive as their module one project. In this application, we redesign the FBI's most wanted database to create an application that allows our user, an FBI agent, to read, analyze, input, update and remove information about fugitives and their crimes in various cities across the US. To get started, we seed our application with real-time data from the FBI's open API, allowing our application access to current information about the FBI's most wanted criminals.
The user in our application is an FBI agent. In future versions of our program, the functionality could be expanded to include citizens who might want to use the application to access crime data or report information and tips to the FBI regarding fugitives that are at large.
Our application utilizes the following models:
- Fugitive: a fugitive has many crimes and has many cities through crimes
- City: a city can have many crimes and has many fugitives through crimes
- Crime: crimes belongs to a city and fugitive
- This app is working with Ruby 2.6.1
rvm install 2.6.1
- Fork and clone this repository into your local environment
- Run
bundle install
in your terminal - Run the
rake prepare_database
to create, migrate, and seed your database with data from the FBI database. This will also being running the app - Follow the prompts with your arrow key to get started. Additionally, you will need to use your keyboard to a
- If at any time you exit the application, run
rake enter
in your terminal to re-enter the application
- Access Fugitive Data: allows users the ability to access data about age, physical features, distinguishing marks, warnings, or fugitive status using a name, fugitive ID number, or location
- Data Analysis: allows users to access data about oldest fugitives, youngest fugitives, most common hair color, and the most wanted fugitive
- Access Crime Data: allows users the ability to access information about the description, subject, reward, and date recorded using a crime ID, fugitive name, or location
- Most Common Location: data regarding the most common location of crimes
-
Access Records: allows users the ability to access crime and fugitive data or perform a data analysis
- Update Records: allows users the ability to update crime, fugitive, and city information in the database
- Update Fugitive Data: allows users the ability to update or correct any information about a fugitive
- Update Crime Data: allows users the ability to update or correct any information about a crime
- Update City Data: allows users the ability to update or correct a city name
-
Create New Records: allows users the ability to enter information into the database about a new crime, fugitive, or city name
-
Remove Records: allows users the ability to remove a crime, fugitive or city from the database
https://api.fbi.gov/docs#!/Wanted/get_wanted
Abbie Coghlan & Lisa McGerr
The FBI have no affiliation to this application. Their public database has been used to create an application for educational purposes only.