Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update contributors guide #285

Merged
merged 9 commits into from
Dec 18, 2021
Merged

docs: update contributors guide #285

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ee91155
docs: update quickstart
kangmingtay Nov 22, 2021
c0bd4a3
docs: update gotrue local setup & pr guidelines
kangmingtay Dec 13, 2021
192f839
chore: update example.env
kangmingtay Dec 13, 2021
5c278fa
chore: update Makefile
kangmingtay Dec 14, 2021
f3f3ba2
Rework Contributing docs
dthyresson Dec 15, 2021
29f4b1e
Adds info to customize PG port
dthyresson Dec 15, 2021
12e61ec
Wordsmithing
dthyresson Dec 15, 2021
980a3f0
Add How to Use Admin API Endpoints section
dthyresson Dec 15, 2021
d9a6ede
docs: update contributing with go setup instructions & fix typo
kangmingtay Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ user data.

Create a `.env` file to store your own custom env vars. See [`example.env`](example.env)

```sh
./hack/postgresd.sh
make build
./gotrue
1. Start the local postgres database in a postgres container: `./hack/postgresd.sh`
2. Build the gotrue binary: `make build` . You should see an output like this:
```
go build -ldflags "-X github.com/supabase/gotrue/cmd.Version=`git rev-parse HEAD`"
GOOS=linux GOARCH=arm64 go build -ldflags "-X github.com/supabase/gotrue/cmd.Version=`git rev-parse HEAD`" -o gotrue-arm64
```
3. Execute the gotrue binary: `./gotrue` (if you're on x86) `./gotrue-arm64` (if you're on arm)

## Configuration

Expand Down