Skip to content

Commit

Permalink
docs: Update contributing guide with authentication setup instructions (
Browse files Browse the repository at this point in the history
#261)

Co-authored-by: Eva Decker <[email protected]>
  • Loading branch information
belhajManel and evadecker authored Dec 7, 2024
1 parent bdc6e19 commit 761912e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ Once your Convex account and project is created, a `.env.local` file will be gen
> [!NOTE]
> If this is your first time using Convex, [follow the tour](https://docs.convex.dev/get-started) to understand how the system works and read [The Zen of Convex](https://docs.convex.dev/zen) to understand best practices.
### Set up authentication (first time only)

Namesake authenticates users with [Convex Auth](https://labs.convex.dev/auth). To initialize authentication for local development, run:

```shell
npx @convex-dev/auth
```

> [!NOTE]
> If you run into issues or prefer to set up authentication manually, refer to Convex Auth's [manual setup guide](https://labs.convex.dev/auth/setup/manual).
## Making changes

### Start the dev server
Expand Down

0 comments on commit 761912e

Please sign in to comment.