Police Suppression Order System.

This solution starter was created by technologists from IBM.

Jimmy Cesar, Benjamin Chance, Kallie Fergerson, Kimberly Holmes, Paul Jennas, Victoria Kanicka, Henry Nash, Joe Nichols, Jeremy O'Mard, Osai O Osaigbovo, Tiffani Rice, Andrea Ritterbeck, Thomas Schott

1. Overview
2. The idea
3. How it works
4. Diagrams
5. Documents
6. Technology
7. Getting started
8. Resources
9. License

TBA

Provide a publically available, expandable system to enable attorneys and interested groups and individuals to have access to the details of suppression orders, searchable by officer, precinct and geographic area.

TBA

TBA

TBA

TBA

• Register for an IBM Cloud account.
• Install and configure IBM Cloud CLI.
• Install React Native CLI dependencies (for iOS).
  • Node.js
  • Watchman
  • Xcode
  • CocoaPods
• Clone the repository.

1. Provision a CouchDB instance using Cloudant.
2. Run the server.
3. Run the mobile application.

TBA - [if running in the sandbox, there is a short cut to this]

Log into the IBM Cloud and provision a CouchDB instance using Cloudant.

1. From the catalog, select Databases and then the Cloudant panel.
2. Once selected, you can choose your Cloudant plan -- there is a free tier for simple testing that is sufficient to run this CIR example. You should choose an appropriate region, give the service a name, and it is recommended you choose Use only IAM under Available authentication methods. You can leave the other settings with their defaults. Click the blue Create button when ready.
3. Once your Cloudant instance has been created, you need to create a service credential that the CIR API Server can use to communicate with it. By selecting your running Cloudant instance, you can choose Service credentials from the left-hand menu. Create a new service credential and give it a name (it doesn't matter what you call it).
4. Once created, you can display the credentials by selecting view service credentials, and then copy the credential, so you are ready to paste it into the code of the API server in Step 4.

To set up and launch the server application:

1. Go to the code/server-app directory of the cloned repo.
2. Copy the .env.example file in the code/server-app directory, and create a new file named .env.
3. Edit the newly created .env file and update the CLOUDANT_ID and CLOUDANT_IAM_APIKEY with the values from the service credential you created in Step 1. (Note that the username from the credential is what should be used for the CLOUDANT_ID.)
4. Edit the name value in the manifest.yml file to your application name (for example, my-app-name).
5. From a terminal:
   1. Go to the code/server-app directory of the cloned repo.
   2. Install the dependencies: npm install.
   3. Launch the server application locally or deploy to IBM Cloud:
      • To run locally:
        1. Start the application: npm start.
        2. The server can be accessed at http://localhost:3000.
      • To deploy to IBM Cloud:
        1. Log in to your IBM Cloud account using the IBM Cloud CLI: ibmcloud login.
        2. Target a Cloud Foundry org and space: ibmcloud target --cf.
        3. Push the app to IBM Cloud: ibmcloud app push.
        4. The server can be accessed at a URL using the name given in the manifest.yml file (for example, https://my-app-name.bluemix.net).
   4. The api supports a swagger doc interface in a browser, served from url/api-docs. Substitutue your particular server address for url e.g. http://localhost:3000/api-docs if running locally.

To run the mobile application (using the Xcode iOS Simulator):

1. Go to the code/mobile-app directory of the cloned repo.
2. Copy the .env.example file in the code/mobile-app directory, and create a file named .env.
3. Edit the newly created .env file:
   • Update the STARTER_KIT_SERVER_URL with the URL to the server app launched in the previous step.
4. From a terminal:
   1. Go to the code/mobile-app directory.
   2. Install the dependencies: npm install.
   3. Go to the ios directory: cd ios.
   4. Install pod dependencies: pod install.
   5. Return to the mobile-app directory: cd ../.
   6. Launch the app in the simulator: npm run ios. You should be running at least iOS 13.0.
   7. The first time you launch the simulator, you should ensure that you set a Location in the Features menu.

With the application running in the simulator, you should be able to navigate through the various screens:

TBA

• IBM Cloud
• IBM Cloudant
• Node.js
• React Native

This solution starter is made available under the Apache 2 License.