We want to:

1. Use Truth instead of AssertJ (current) for fluent assertions
2. Mirror the directory structure for Java unit tests (ex: /app/my/path/MyClass.java has unit tests under /tests/my/path/MyClassTest.java)

Done when:
a) Our current unit tests are in files that mirror their implementation classes
b) Current tests use Truth rather than AssertJ

Includes:

• Database stores list of programs
• UI renders this list

hello, world

Done when this doc has a final list of decided-upon technologies.

We should choose something for each of the following:

• language and possibly a framework
• package manager
• styles language
• unit testing framework
• module bundler

• Question Builder UI not necessary yet; can be hardcoded

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
Create a Java interface for the internal program service.

Something along the lines of

interface ProgramService {
  ImmutableList<ProgramDefinition> listProgramDefinitions();

  ProgramDefinition getProgramDefinition(String programId);

  // also create, update, destroy ProgramDefinition

 // may also include CRUD for block actions
}

Additional context
This is how the program service controllers and applicant service will interact with the program service.

Done when
Done when the interface is available in the UAT server.

Error Prone is a static analysis tool for Java that catches common programming mistakes at compile-time. It's designed for plug-and-play usage with several build systems that are not the one we're using. This task is to take a look at it and get an idea of how much work it'd be to set up for our project. If it ends up being fairly straightforward, go ahead and do it.

We want to make it as easy as possible for newcomers (e.g. city employees, other civic groups, the general public, etc.) to contribute code and ideas to this project. Write a few paragraphs in the README (or make a separate CONTRIBUTING.md doc) to teach people how to do this.

Include:

• How we do project management
• Etiquette for contributing (using issue templates, asking someone for review, etc.)
• Best places to look if you want to get started

(Tech stack is already included in great detail, so no need to add more.)

Building on #33, create a template for issues. Include "done-when" criteria.

Would be good to put some forethought into how we structure our packages and directories. We can put these in the README.

Oracle IDCS has support for OAuth 2.0, OpenID Connect, SAML, SDK, and REST. We should select a method that works well with Play, is supported by the City, and provides flexibility for other civic entities to use with their authentication systems.

Done when we have documented which method we will use for the integration

Create a Java interface for the internal question service.

Something along the lines of

interface QuestionService {
  // create, update, list, get question definitions
  // get question definition for path
}

Additional context
This is how the question service controllers, program service, and applicant service will interact with the question service.

Done when
Done when the interface is available in the UAT server.

blocked on #104

Done when
Admin can submit the form from #104 and persist a new program definition.

Blocked by #95

Done when
Admin submit the form from #95 and persist a new question definition.

We'll use Sass for our stylesheets.

Based on this reference for community plugins, we probably want to include the sbt-puresass and sbt-web plugins.

Done when we can serve a page styled with Sass.

• Does not need to be with UI; can be hardcoded for now

Should include "Fixes #..., fixes #...." and "Blocked by #..., #..."

Trying to connect to AB#1

The development server takes quite a while to serve its first response because it waits to compile until it's received its first request. Investigate the cause of this and find a solution that either reduces the compilation time or does it on initial server start and gets it out of the way.

Done when: serving the first request request does not require waiting for recompilation

Currently our formatter favors combining annotations onto one line when the fit (like on a variable). Annotations should each be on their own line.

Blocked by #101

Done when
Admin can view the form for an existing question definition and submit it to update the question definition

Create a terraform config and continuous deployment (evaluate Terraform Cloud? GitHub Actions may be suitable for this as well, which would help keep all config in one place).

Done when
The applicant service can accept Updates along with a specific applicant and persist the updates.

We should create an initial functional page to figure out all the parts involved with setting that up.

This page can be a "Create a new application" page for the UAT admin role that saves the name of the new application, e.g.

Off the top of my head, we'll need:

• a twirl template file
• a controller
• routing config
• ebean class(es)
• some TS (just to prove to ourselves that we can get that working)
• some other stuff I'm likely missing

Done when
Admin can view list of questions i.e. the question bank

Additional context
Represents a program as configured by the admin. Has many BlockDefinitions.

Done when
The ProgramDefinition class is available in the UAT server.

We wish to use play-pac4j, which is a security library for Play that supports authentication and authorization. We first need to install the library dependencies

Done when: pac4j is enabled in our Play app

Explain why cities should adopt our product, and what advantages it has over all the other "benefits application portals" that various civic groups have created throughout the years. Ideally, should also explain why other civic tech groups should start working on this project.

Write a few paragraphs at the start of the README explaining the value prop to newcomers.

Additional context
This will help unblock applicant service work.

Done when
A BlockDefinition class exists that represents a block the admin has configured in a specific program.

This form allows an admin to create a new question (i.e. a QuestionDefinition) using the NAME question type.

• Simple text input field for question path for now
• question and help text are only for english locale
• question type selected from dropdown
• version hard-coded to "1" for now
• no tags

Done when admin can view the question form.

Once we decide on a unit test framework (probably either Jest or Jasmine), we should write a test as an example, both to encourage writing tests with code from the start, and to get TS tests set up with our CI.

Done when we have a passing TypeScript unit test that runs as part of our CI.

This is an epic that I created from ZenHub.

Show the various screens of the app (not wireframes; just boxes & arrows is fine) and how each user group will move through them.

• add command in bin/ to stand up docker swarm and run some tests
• connect database to play app - link @hmhsu
• add basic schema management - link @ndmckinley

Blocked on #97, #98

Describe the solution you'd like
Admin can view a form for creating a new program. For now that form only has fields for the program name and description.

Done when
Admin can view the form

The main task here is to add the addSbtPlugin line from here, but it's worth reading through the rest of the steps there and configuring anything else we think we'll need. I chose that particular plugin based on the link in this sbt Reference Manual.

(I mostly created this task in order to try out the flow of creating a GitHub issue and then associating it with a PR).