You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update CONTRIBUTING.md for macOS installation instructions (#1893)
## What kind of change does this PR introduce?
Docs update: Add macOS installation instructions to the CONTRIBUTING.md
file. Fixes#1685.
## What is the current behavior?
The current CONTRIBUTING.md does not include specific installation
instructions, which may lead to confusion during setup.
## What is the new behavior?
This PR updates outdated instructions in the CONTRIBUTING.md file.
ensuring a smoother setup experience for contributors.
If you are on macOS Catalina you may [run into issues installing Soda with Brew](https://github.com/gobuffalo/homebrew-tap/issues/5). Do check your `GOPATH` and run
87
89
88
90
`go build -o /bin/soda github.com/gobuffalo/pop/soda` to resolve.
89
91
90
-
```
91
-
go install github.com/gobuffalo/pop/soda@latest
92
-
```
93
-
94
92
- Clone the Auth [repository](https://github.com/supabase/auth)
95
93
96
-
```
94
+
```zsh
97
95
git clone https://github.com/supabase/auth
98
96
```
99
97
@@ -116,67 +114,44 @@ To complete installation, you will:
You should then see in Docker that `auth_postgresql` is running on `port: 5432`.
163
126
164
127
> **Important** If you happen to already have a local running instance of Postgres running on the port `5432` because you
165
-
> may have installed via [homebrew on OSX](https://formulae.brew.sh/formula/postgresql) then be certain to stop the process using:
128
+
> may have installed via [homebrew on macOS](https://formulae.brew.sh/formula/postgresql) then be certain to stop the process using:
166
129
>
167
130
> -`brew services stop postgresql`
168
131
>
169
132
> If you need to run the test environment on another port, you will need to modify several configuration files to use a different custom port.
170
133
171
134
3. Next compile the Auth binary:
172
135
136
+
When you fork a repository, GitHub does not automatically copy all the tags (tags are not included by default). To ensure the correct tag is set before building the binary, you need to fetch the tags from the upstream repository and push them to your fork. Follow these steps:
137
+
138
+
```zsh
139
+
# Fetch the tags from the upstream repository
140
+
git fetch upstream --tags
141
+
142
+
# Push the tags to your fork
143
+
git push origin --tags
173
144
```
145
+
146
+
Then build the binary by running:
147
+
148
+
```zsh
174
149
make build
175
150
```
176
151
177
152
4. To setup the database schema via Soda, run:
178
153
179
-
```
154
+
```zsh
180
155
make migrate_test
181
156
```
182
157
@@ -200,7 +175,8 @@ Version Name Status
200
175
201
176
That lists each migration that was applied. Note: there may be more migrations than those listed.
202
177
203
-
4. Create a `.env` file in the root of the project and copy the following config in [example.env](example.env)
178
+
4. Create a `.env` file in the root of the project and copy the following config in [example.env](example.env). Set the values to GOTRUE_SMS_TEST_OTP_VALID_UNTIL in the `.env` file.
179
+
204
180
5. In order to have Auth connect to your PostgreSQL database running in Docker, it is important to set a connection string like:
0 commit comments