Skip to content

Updating the readme to point people to the HOWTO file#1114

Closed
rcackerman wants to merge 7 commits intoProgressiveCoders:locallogin-defaultdevfrom
rcackerman:locallogin-defaultdev
Closed

Updating the readme to point people to the HOWTO file#1114
rcackerman wants to merge 7 commits intoProgressiveCoders:locallogin-defaultdevfrom
rcackerman:locallogin-defaultdev

Conversation

@rcackerman
Copy link
Copy Markdown

I've updated the readme to be clearer to a semi-technical person (ie me).

I also separated the postgres part but am happy to put it back in.

@shakalee14
Copy link
Copy Markdown
Contributor

Hey @rcackerman - can you resolve conflicts?

@rcackerman
Copy link
Copy Markdown
Author

@shakalee14 Done! Sorry about that.

README.md Outdated
1. To skip using the SMS provider (useful for development), set `DEFAULT_SERVICE=fakeservice`.
2. Determine which database to use and set the necessary variables, listed in the [reference](https://github.com/MoveOnOrg/Spoke/blob/main/docs/REFERENCE-environment_variables.md).
- To use Postgres, [follow these instructions](https://github.com/MoveOnOrg/Spoke/blob/main/docs/HOWTO_USE_POSTGRESQL.md).
3. Spoke uses [Auth0](https://auth0.com) by default. However, for development, there are a few ways to bypass authentication.
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add PASSPORT_STRATEGY=local for dev

@@ -0,0 +1,7 @@
# How to set up Spoke with Postgresql

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first time the app is run, the tables will be created.

@schuyler1d schuyler1d requested review from ibrand and shakalee14 June 19, 2019 00:32
Copy link
Copy Markdown
Collaborator

@schuyler1d schuyler1d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@schuyler1d schuyler1d added needs qa round S-ready for stage-main (qa) Status (ADMINS ONLY): PR label for those ready to be added for stage: Approved, tests, etc labels Jun 19, 2019
@ibrand
Copy link
Copy Markdown
Collaborator

ibrand commented Jun 19, 2019

These are great. They feel really clear and helpful, thank you!

@shakalee14 shakalee14 mentioned this pull request Jun 19, 2019
Copy link
Copy Markdown
Contributor

@shakalee14 shakalee14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much! This is a lot more readable!

@shakalee14
Copy link
Copy Markdown
Contributor

Merged with #1150

@shakalee14 shakalee14 closed this Jul 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-ready for stage-main (qa) Status (ADMINS ONLY): PR label for those ready to be added for stage: Approved, tests, etc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants