Skip to content

Commit 83dbdc8

Browse files
authored
Readme edits (#329)
* readme update for authentication * readme google client * formatting * formatting * clarity for client ID * troubleshooting section * formatting * reorder readme
1 parent 798e040 commit 83dbdc8

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,23 @@ There are two ways to run Compass locally:
8888

8989
Server URL: http://localhost:3000
9090

91+
### Authentication
92+
93+
.env.local file will need to be updated for sign in with Google
94+
95+
To update GOOGLE_CLIENT_ID:
96+
97+
- Navigate to Google Cloud
98+
- Create a "Client ID for Web application"
99+
- Populate the fields as below (note the name and authorized redirect URIs fields)
100+
![alt text](readmeassist.jpg)
101+
102+
* Copy the client ID field on the upper right of the modal (not shown in screenshot), after creation
103+
104+
To update GOOGLE_CLIENT_SECRET:
105+
106+
- Copy the google client secret after creation of the client id
107+
91108
### Running tests
92109

93110
The database container does not need to be started to run tests, but Docker Desktop must be running in the background.
@@ -106,6 +123,16 @@ Until Compass is deployed, the initial migration file at `src/api/db/migrations/
106123

107124
Run `npm run db:migrate` to migrate the database. However, until Compass is deployed, you'll more likely want to run `npm run db:reset` to reset the database since we'll be making changes to the initial migration file.
108125

126+
### Troubleshooting
127+
128+
Compass app is not running:
129+
130+
Make sure that Docker is running in the background
131+
132+
Client id is required:
133+
134+
Fill out the Google Client ID and Google Client Secret in .env.local
135+
109136
## Tech stack & libraries
110137

111138
- [Winston](https://github.com/winstonjs/winston)

readmeassist.jpg

88.4 KB
Loading

0 commit comments

Comments
 (0)