Commit Graph

138 Commits

Author SHA1 Message Date
Carlo Costino
844cab2e3d Updated references of US Notify to Notify.gov
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-22 13:53:15 -05:00
Carlo Costino
b2f91cc533 Minor README.md updates
This changeset makes a few more adjustments to the README.md file to account for updates in the other repos that are forthcoming.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-22 10:21:22 -05:00
Carlo Costino
ba7c310fdd Adds additional instructions for virtual environments
h/t to @xlorepdarkhelm for the suggestions!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 15:10:07 -05:00
Carlo Costino
a28120ec64 Minor formatting adjustments of notes.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1859669a6d Added missing feedback about PostgreSQL versions
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1ee9b73832 Improvements based on review feedback
h/t to @stvnrlly for the suggestions!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1b8fb4206d Fixed brew install command
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
dd571152b7 More minor adjustments
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1815028aac Plain-language, grammatical, and formatting adjustments
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
7c1fa1bd75 Update README with new instructions and improve setup
This changeset updates the README.md file with a set of entirely new instructions. These updates are intended to improve clarity, simplify steps, and reduce confusion and environment-setup gotchas that folks have run into previously and we have learned from.  A couple of other changes are also included:

- Minor adjustments to the Makefile to improve make bootstrap
- Updates to the sample.env file to include previously missing required environment variables

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:44 -05:00
Beverly Nguyen
a28358c0db updated readme 2023-11-14 09:34:50 -08:00
Carlo Costino
d6d11746b1 Update more dependencies and fix notifications-utils
This changeset updates a few more dependencies and addresses the challenges we have had in keeping the notifications-utils dependency up-to-date.  The changes include instructions on what to do going forward for future notifications-utils updates.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-01 12:15:53 -04:00
Carlo Costino
4b2586cd3b Added instructions to the README
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-10-30 16:56:40 -04:00
Steven Reilly
96b224d159 streamline setup instructions 2023-09-29 10:36:39 -04:00
stvnrlly
04bd91758b update doc links in readme 2023-09-18 16:50:52 -04:00
stvnrlly
d345b21546 update pipenv references 2023-09-05 12:19:42 -04:00
stvnrlly
dd0bf646c4 reorder docs 2023-08-28 12:08:06 -04:00
stvnrlly
25af2df15c combine all docs together, to be cleaned up 2023-08-22 17:36:00 -04:00
Carlo Costino
babdd70839 Add Architectural Decision Records to US Notify (#284)
This changeset introduces Architectural Decision Records (ADRs) to the US Notify project.  This initial commit includes the following:

- Updates to the main project README.md that mentions ADRs
- A new adr/ folder under the docs/ folder
- An ADR template to copy and follow for the future
- Our first ADR, ADR-0001 - Establishing ADRs
- A README.md specific to ADRs that has more information and instructions
- ADR-0001 finalized and accepted

A huge thank you to @stvnrlly for the help in making this come together!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
Co-authored-by: Steven Reilly <stvnrlly@users.noreply.github.com>
2023-06-06 15:34:01 -04:00
Steven Reilly
881f479417 Small doc updates (#253) 2023-05-02 10:25:02 -04:00
Ryan Ahearn
9eb075f074 Address PR feedback 2023-03-14 15:36:32 -04:00
Steven Reilly
886db509a0 update docs for project setup (#190) 2023-03-07 09:56:12 -05:00
stvnrlly
9a1df7cf06 link to new doc in readme 2022-11-30 11:59:04 -05:00
stvnrlly
b50cb4712f tz utility swap and many test updates 2022-11-10 12:33:25 -05:00
stvnrlly
57adbf3f6b document create-test-user command 2022-11-01 12:14:26 -04:00
Ryan Ahearn
db96c4d82f Replace foreman with honcho 2022-11-01 09:54:31 -04:00
Ryan Ahearn
55bccecf10 Merge branch 'main' into cleanup-config
* main:
  add the requirements.txt file during deploy 🤷
  add versions in pipfile for git deps
  use setup action in deploy workflow
  include new/renamed files
  update licensing situation for us gov
2022-11-01 09:39:52 -04:00
Ryan Ahearn
a4aedee572 Add Procfile.dev to ease running of flask & celery in dev 2022-11-01 09:35:55 -04:00
stvnrlly
d55c099043 update licensing situation for us gov 2022-10-28 16:20:41 -04:00
stvnrlly
64f8641013 improvements from feedback 2022-10-28 12:48:22 -04:00
stvnrlly
9b32bb55ea more ci info 2022-10-28 11:11:17 -04:00
stvnrlly
56329daa9a more docs 2022-10-26 15:45:45 +00:00
stvnrlly
d27401c7a0 more pipenv transition 2022-10-26 14:05:37 +00:00
stvnrlly
a45e02d6e5 restructure readme & docs 2022-10-20 14:05:23 -04:00
Ryan Ahearn
e3ad01119d Replace celery[sqs] with celery[redis] 2022-09-29 08:59:17 -04:00
Jim Moffet
b8001ea96b Merge pull request #26 from 18F/devdocs_update2
Updates to quickstart while onboarding Carly
2022-08-29 10:43:49 -07:00
Ryan Ahearn
f90f32f032 Document how to run the owasp scan locally 2022-08-23 16:59:39 -04:00
Ben Klaas
9aa9ea65c2 Updates to quickstart while onboarding Carly 2022-08-22 14:25:39 -05:00
Ben Klaas
b32585d20d Remove old QUICKSTART 2022-08-05 02:34:29 +00:00
Ben Klaas
9f21018d8e Update QUICKSTART 2022-08-05 02:22:21 +00:00
Jim Moffet
1bbb8a4aab Update README 2022-08-01 10:56:16 -07:00
Jim Moffet
1fbc4d6241 Update README 2022-08-01 10:53:27 -07:00
Jim Moffet
f7060af2ff Update README 2022-08-01 10:50:50 -07:00
James Moffet
18a04fd719 configs 2022-07-25 15:19:05 -07:00
James Moffet
f0cb133129 update readme with SES/SNS instructions 2022-07-14 13:36:05 -05:00
Jim Moffet
3457c5a687 Add secrets detection section to readme 2022-06-28 15:30:09 -07:00
Ben Thorner
c27107fa74 Remove support for Reach provider
This provider was never active and support was never completed, so
there's little value in keeping all this potentially confusing code.
2022-04-29 12:28:08 +01:00
Ben Thorner
015152bab2 Add boilerplate for sending SMS via Reach
This works in conjunction with the new SMS provider stub [^1].

Local testing:

- Run the migrations to add Reach as an inactive provider.
- Activate the Reach provider locally and deactivate the others.

      update provider_details set priority = 100, active = false where notification_type = 'sms';
      update provider_details set active = true where identifier = 'reach';

- Tweak your local environment to point at the SMS stub.

      export REACH_URL="http://host.docker.internal:6300/reach"

- Start / restart Celery to pick up the config change.
- Send a SMS via the Admin app and see the stub log it.
- Reset your environment so you can send normal SMS.

      update provider_details set active = true where notification_type = 'sms';
      update provider_details set active = false where identifier = 'reach';

[^1]: https://github.com/alphagov/notifications-sms-provider-stub/pull/10
2022-03-30 13:38:46 +01:00
Ben Thorner
c0f60a5c21 Replace pycurl guidance with psycopg2
Since we moved to Dockerised Celery the pycurl guidance should no
longer be necessary and doesn't work on newer Mac M1 machines.

This also adds new guidance for psycopg2, which will hopefully be
temporary (see issue comment).
2022-03-15 15:58:18 +00:00
Ben Thorner
ae41075151 Fix incorrect code block formatting in README 2022-03-08 12:42:14 +00:00