dobtco / beacon Goto Github PK

Now:

• Project governance
• Contribution guidelines
• Code of conduct (Maybe DOBT can implement one across all our open source repos?)

After development:

• Installation
• Customization
• Deployment
• Maintenance

From @bsmithgall on August 24, 2015 5:29

Here are some obvious candidates:

• Beacon categories stuff

Copied from original issue: codeforamerica/pittsburgh-purchasing-suite#255

(@bsmithgall edit: Edited to remove things that don't exist in Beacon)

To reproduce:

Change the opportunity type for an opportunity while it is in the "pending" state.

Outcome:

• Allow developers to spend less time configuring their environment, while still being able to test outbound emails

Brainstorming

Can we do something like Django's "console" or "file" email? https://docs.djangoproject.com/en/1.9/topics/email/#configuring-email-for-development

(We use https://github.com/ryanb/letter_opener for Rails.)

Another option would be to use a dummy SMTP server, like: https://nilhcem.github.io/FakeSMTP/

Apparently, you can even run one with a simple python one-liner: http://serverfault.com/a/248838

We use premailer (Ruby) in our other apps and it's pretty magical. Since most everyone uses HTML email clients, you can just leave out the text-only email templates, and they'll get generated automatically from the HTML.

I wonder if there's something similar for python?

Maybe we need to enable http://jinja.pocoo.org/docs/dev/api/#autoescaping?

/cc @bsmithgall. This might be an issue on the production (buildpgh) site, too?

Problem:

Currently, you can enter the email address of any registered vendor and manage their subscriptions. Theoretically, a bad actor could unsubscribe all of their competitors from RFP notifications.

Solution:

In order to re-authenticate vendors, send a link via email that must be clicked in order to proceed.

The url is https://screendoor.dobt.co/projects/:embed_token/admin, and should be live soon.

Frontend mockups: http://big-ideas-prototype.dobt.co/opportunity/#new_question
Backend mockups: http://big-ideas-prototype.dobt.co/admin/opportunity/qa/

Rough acceptance criteria:

• Admins can enable questions on an RFP, and optionally add open & close dates for the Q&A period
• Vendors can ask qusetions
• Vendors can browse all questions
• Admins can answer questions
• Both admins and vendors receive email notifications when a question is asked/answered, respectively

Frontend mockups: http://big-ideas-prototype.dobt.co/new_proposal/
Backend mockups: http://big-ideas-prototype.dobt.co/admin/new_opportunity_2/

Rough acceptance criteria:

• Admins can choose "I want to accept submissions via Screendoor" and enter an Screendoor embed token
• Vendors can click "Propose" and be presented with a Screendoor form

From @bsmithgall on September 2, 2015 22:3

Is this the desired behavior? I feel like we haven't really thought about this use case all the way.

Copied from original issue: codeforamerica/pittsburgh-purchasing-suite#327

From @bsmithgall on August 25, 2015 16:38

Copied from original issue: codeforamerica/pittsburgh-purchasing-suite#285

from https://github.com/dobtco/beacon/wiki/Meeting-minutes---1-19-16:

Want to set "gold standard" for open-source, redeployable civic tech:

• Clear governance
• Actively maintained
• Strike the right balance between convention and customization

Outcomes:

• An implementation can customize:
  • Language
  • Stylesheets
  • Settings
  • Templates, maybe?
• Customization lives separately from the "core", so that updates can be applied without merging or rebasing
• A technically-minded, but non-programmer user can do the customization with ease, and without fear that they will break things

References:

• Alaveteli: https://github.com/mysociety/alaveteli and its themes: https://github.com/mysociety/dirittodisapere-theme

Outcome

• Provide deployment instructions that are easy to follow, and provide a robust configuration for production usage.
• No vendor lock-in?

Structure

• Heroku + an alternative (Cloud66?)
• Docker?

@bsmithgall is doing this for Pittsburgh, so we'll merge it into here when he's done.

EDIT: I've also offered to help code review, etc.