|
| 1 | +<img src="/packages/@aetherspace/assets/AetherspaceLogo.svg" width="50" height="50" /> |
| 2 | + |
| 3 | +<p> |
| 4 | + <a href="https://clerk.com/" target="_blank"> |
| 5 | + <img alt="Clerk Auth Logo" longdesc="Cross Platform Auth with Clerk" src="https://camo.githubusercontent.com/02b3799f98edbed5bafa868dbd884287f249d3153e53c34b3c05855adf2478a2/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f7374796c653d666f722d7468652d6261646765266d6573736167653d436c65726b26636f6c6f723d364334374646266c6f676f3d436c65726b266c6f676f436f6c6f723d464646464646266c6162656c3d" /> |
| 6 | + </a> |
| 7 | +</p> |
| 8 | + |
| 9 | +# `@aetherspace/clerk-auth` - Aetherspace Plugin |
| 10 | + |
| 11 | +Prerequisites: |
| 12 | +- [Sponsor Aetherspace on Github](https://github.com/Aetherspace/green-stack-starter-demo#readme) or get access to it some other way |
| 13 | +- Fork or generate a new repository from the official or free [aetherspace/green-stack-starter](https://github.com/Aetherspace/green-stack-starter#readme) github repo |
| 14 | +- Choose the "✅ Include all branches" option during the fork / generation process |
| 15 | + |
| 16 | +```shell |
| 17 | +git merge with/clerk-auth |
| 18 | +``` |
| 19 | + |
| 20 | +After a yarn install, you'll be able to use `@aetherspace/clerk-auth` to import a bunch of handy clerk auth helpers: |
| 21 | + |
| 22 | +```shell |
| 23 | +│── apps/ |
| 24 | +│ └── nextjs/ |
| 25 | +│ └── middleware.ts/ # ➡️ Clerk auth middleware already set up for you |
| 26 | +│ |
| 27 | +│── packages/ |
| 28 | +│ └── @aetherspace-clerk-auth/ |
| 29 | +│ └── schemas/ # ➡️ Zod schemas for clerk datastructures to re-use for types, resolvers & docs |
| 30 | +│ └── context/ # ➡️ Universal context for clerk on web & native |
| 31 | +│ └── hooks/ # ➡️ Universal hooks for clerk on web & native |
| 32 | +│ └── middleware/ # ➡️ SWR middleware to ensure clerk auth headers are included on mobile |
| 33 | +│ └── utils/ # ➡️ Utils to create auth related request context in Next.js middleware |
| 34 | +│ └── components/ # ➡️ Handy universal components like a SignOutButton you can make your own |
| 35 | +``` |
| 36 | + |
| 37 | +We'll also set you up with a `features/user-managment` workspace for some example integration code: |
| 38 | + |
| 39 | +```shell |
| 40 | +│── features/ |
| 41 | +│ └── user-managment/ # ➡️ importable from 'user-management' |
| 42 | +│ └── schemas/ # ➡️ Zod schemas for state management & auth request context |
| 43 | +│ └── hooks/ # ➡️ Typed form states for the clerk based auth forms |
| 44 | +│ └── screens/ # ➡️ Example SignIn, SignUp, UserInfo screens |
| 45 | +│ └── routes/ # ➡️ Example routes for /sign-in, /sign-up, /me |
| 46 | +│ └── resolvers/ # ➡️ Retrieve user data from the request context |
| 47 | +`````` |
| 48 | + |
0 commit comments