18f / afsbirez

(Inactive) The SBIR-EZ project, whose goal is to simplify the process of participating in the Small Business Innovation Research Program

SBIR-EZ

The SBIR-EZ (sih-bur-easy)project, provides a web service and user interface abstraction over the Small Business Innovation Research Program suite of tools used by SBIR.gov, DoDSBIR.com and various agency tools. The intent is that users may have a uniform interface to:

• Research existing and past SBIR solicitations
• Save opportunities for later processing
• Apply to opportunities independently of the owning agency
• Track the status of applications
• Receive and send communications
• View benchmarks

Please file issues at the central repository for all Air Force Small Business repo

Installation

• Install Postgresql
• Install Python 3.4.1
• Install pip
• Install virtualenv

$ git clone https://github.com/18F/afsbirez.git
$ cd afsbirez

• Make a virtualenv

The directory hosting the virtualenv can be anywhere you want; keeping it here within the afsbirez directory aids in clarity.

$ mkdir env
$ virtualenv-3.4 ./env

• Activate the virtualenv

$ source env/bin/activate

• Install project requirements

$ pip install -r requirements.txt

You should now see (env) on your command prompt:

$ (env)[afsbirez]

• Install the latest Node.js

• Update NPM to the latest version

$ npm install npm -g

• Install the bower command line clients, as well as the karma test runner.

$ npm install

• install client side dependencies via bower

$ bower install

Configure the database

Check your pg_hba.conf file on your system to allow local connections without passwords. pg_hba.conf location varies from system to system; to find yours, you can use

psql -t -P format=unaligned -c 'show hba_file' template1

Your hba.conf should have the following lines already in place:

local   all             all                                     trust
host    all             all             127.0.0.1/32            trust

Create a database and role with your system user name

$ psql -c "create user afsbirez with superuser password 'afsbirez';" -U postgres
$ psql -c 'CREATE DATABASE afsbirez WITH OWNER afsbirez;' -U postgres

Create the database tables on 'afsbirez'

$ python manage.py syncdb

Running the Server using the Werkzeug built-in run_simple WSGI server. Please note that this is for

development only.

$ python manage.py runserver

Running Python Tests

$ python manage.py test

Running Javascript Tests

Install Karma globally

npm install -g karma-cli

Run tests

karma start

Run tests in multiple browsers

karma start --browsers Firefox,Chrome

License: Public Domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

afsbirez's Issues

Proposal table of contents doesn't work as designed

Hey @DavidEBest, probably best to have a conversation about this, but:

The proposal table of contents isn't working as I expect it to. The previous/next links only work on occasion and I still see screens of links rather than nice, default forms.

Hitting Enter on the 'Create User' dialog dismisses the dialog without creating a user.

"You’ll need to fill in your company information"

At http://localhost:8000/app/proposals/report/3, my screen continues to show

Note: You’ll need to fill in your company information before you can submit a proposal.

even after the company info has been filled in, which is confusing.

Navigating to the Proposals Page makes two identical calls to the api.

Navigating to the page double-requests the proposals from the server. It shouldn't do that.

Improve test coverage for Topics endpoint

Add (or port over, if possible) tests for the topic endpoint.

Phone number validation too strict?

As of commit 58af3, for field's like principal investigator's Phone, validation doesn't permit variations like

• country code (arguably unwanted for Federal work anyway - opinions?)
• phone extension

This looks small enough that it would probably be a good way for me to ramp toward being useful on the front-end code, so I'm going to assign myself.

A user should be able to navigate through pages of search results

The ux for this is a bit wonky, regardless of whether or not they use a keyboard:

• We should return users to the top of the page after clicking "next"
• We should specify what results are being shown at the top of the page (for example: 11-20 of 52)
• We should programmatically assign focus for screenreaders to the top of this set of results.
• We should update the URL bar so users can share a specific page of results.

I can craft some nicer header styles for displaying the currently displayed results alongside the header

Add in new CI

We migrated off of Travis and needed to remove the config. Add in new CI if development restarts.

API Documentation Improvement

Update the API documentation to match our current output format.

Discretionary Technical Assistance asked redundantly?

"Proposal Information asks"

"Does the proposed cost include Discretionary Technical Assistance (DTA)? " / "If yes, what is the proposed DTA amount"

(cost_includes_dta_yn, dta_amount)

... which feels annoyingly redundant with "Discretionary Technical Assistance" on the Totals page (discretionary_technical_assistance)

Should we auto-fill one from the other? verifty that they match during validation? Remove one from the workflow? None of the above?

Empty popup for "Add to my topics" when not signed in

As of commit 75902b, if I am not logged on, the "Add to my topics" link is available, but clicking it brings up an empty popup (no text).

DCAA audit - accepts both a date and "never performed"

As of commit 58af3, on the Business Information page, "If no, please provide the date for when such a review was last performed" will accept a text answer AND a check in "never performed" without complaining in on-page or final validation.

There's also no date validation on the "when review was performed" but that might be a good thing, to permit answers like "Unknown", "Promised for next year", "In times of yore when giants walked the earth", etc. Opinions?

This looks small enough that it would probably be a good way for me to ramp toward being useful on the front-end code, so I'm going to assign myself.

Put the search query string and page parameters into the url

The search query string & page number should be exposed via the url, but is not.

Change name of application from `afbirez` to `afsbirez`

Issue

There is currently inconsistency between naming conventions on the app. We currently have the name set to afbirez but the application is referred to afsbirez in other avenues.

Fix
Change the name of the application and other files that (e.g. settings/) that point to that path.

"No" questions for dcaa_review are asked if "Yes"

(on version at sbirez.18f.gov)

When answering "yes" to

Has the Defense Contracting Audit Agency (DCAA) or other agreed upon agency, performed a review of your accounts or records in connection with government contracts or subcontracts within the past 12 months?

the text

If no, please provide the date for when such a review was last performed

and

or if never reviewed, check here

appear below the box with the Yes questions. If the No radio button is selected, both the Yes and No questions disappear.

dod_workflow.yaml shows

      ask_if: not dcaa_review

for the No questions, so maybe not isn't working correctly in ask_if?

You published your SECRET_KEY in your repository

Hey, it seems that you published your SECRET_KEY in your repository. Probably this is just a test value and you know what you're doing, just creating this issue in case you did this inadverently.

Here you can find some more information about the issue:

https://www.quantifiedcode.com/app/project/gh:18F:afsbirez?groups=code_patterns%3A1Wit6MHp%3Af0

zip+4 should be optional?

In the mailing address at http://localhost:8000/app/account/organization, the validator won't accept a 5-digit zip code. Did we mean to make the full zip+4 a requirement?

Add ability to receive "Password Reset" emails

Issue
We currently do not have a way for users to receive a password reset email for their user account.

Fix

• Add ability to send emails to users
• Hook in "Password reset" to this functionality

Notes
See Django's docs on how to set that up here https://docs.djangoproject.com/en/1.8/topics/auth/default/#django.contrib.auth.forms.PasswordResetForm

email addresses not validated

As of commit 58af3, on the Principal Investigator page (and probably elsewhere), there's no validation for legitimate email addresses.

However, this MIGHT be a good thing, if we want to accept answers like "None", "Unknown", etc. Opinions?

This looks small enough that it would probably be a good way for me to ramp toward being useful on the front-end code, so I'm going to assign myself.

Time percentage not validated

As of commit 58af3, on the Principal Investigator page, the "What percentage of the principal investigator's total time will be on the project?" field doesn't complain about entries like "110%", "-30%", "mind your own business", etc.

This looks small enough that it would probably be a good way for me to ramp toward being useful on the front-end code, so I'm going to assign myself.

Push to Cloud Foundry

As part of the release sprint, we should push a password protected instance of SBIR-EZ to Cloud Foundry to allow for acceptance testing by the product owner.

Add updated copy + styling for logged out homepage

Per conversation with @DavidEBest, we are currently still in need of a logged out homepage.

No feedback upon successful proposal submission

When I submit a proposal, the verification email is sent, but nothing on the screen at http://localhost:8000/app/proposals/report/3 indicates that the proposal has been submitted.

Create a default admin user for administrative tasks

As part of a fixture or initialization script, an admin user should be created to allow access to the Django admin interface.

no feedback upon successful proposal verification

At http://localhost:8000/app/proposals/report/3, if there are no validation problems, clicking "Verify this proposal" gives no feedback. It would be more clear to have some on-screen indication that verification is complete - ideally the button would dim and be re-labelled "Verified", or something

(I'm actually not certain that button is currently wired up to do anything, come to think of it... my Django window isn't logging any REST calls when I hit the button - delete if this isn't yet relevant)

Topics endpoint does not honor page_size parameter.

If I send the following api request:
http://localhost:8000/api/v1/topics/?closed=true&page_size=2&q=test
I receive 20 results instead of the expected 2.

A user should be able to navigate to the topic details page from the search results

This is missing a "back to search results" link at the top of the page. (The back button isn't broken, though, so that's 👍)

We need a way to link a topic to a workflow.

Right now, everything is hard-coded to use the DoD workflow. It should be determined at the solicitation level.

A Solicitation table could pull the solicitation_id, pre_release_date, proposals_begin_date, and proposals_end_date off of the individual topics and tie them to a solicitation. The solicitation table would also be a logical place for a workflow (or root element) id.

Blank names accepted

As of commit 58af3, on the Eligibility page, fields like "Has your firm been convicted of a fraud..." / "provide the name" accept empty names without complaining in on-page or final validation.

This looks small enough that it would probably be a good way for me to ramp toward being useful on the front-end code, so I'm going to assign myself.

invalid % rates fail silently

As of commit 58af3, on the Totals page, entering a non-numeric value in fields like "General & Administrative Rate" appears to be accepted, but no values are calculated for the dependent fields like "General & Administrative Cost" - even after you go back and replace the % values with legitimate percentages.

Can't visit/link to URLs

Users can't access the following interfaces via a URL:

Sign in:
http://localhost:8000/signin/

Sign up:
http://localhost:8000/signup/

My proposals (I'd suggest removing 'app' from the URL, so it's ~/proposals/):
http://localhost:8000/app/proposals

My company (I'd suggest ~/company/):
http://localhost:8000/account/organization

Any proposal:
http://localhost:8000/app/proposals/12?current=2

Deep "links" inside of proposals. Links to other pages should use href

<a ng-click="method(element.id)" group="element" method="jumpTo" ng-if="element.element_type === 'workflow' || element.element_type === 'group'" class="ng-binding ng-isolate-scope" tabindex="0">Requirements Review</a>

Other stuff

Curiously, password reset works!
http://localhost:8000/reset/

A specific search:
http://localhost:8000/search/?query=test

Add a contributing.md file to the repository

We should add a contributing.md file to describe our process better, and ensure that our documentation is up to date and in compliance with 18F open source policies/best practices.