Skip to content

Commit 5cf580d

Browse files
committed
chore(examples): clean up example READMEs, add deploy buttons
1 parent 00d495d commit 5cf580d

File tree

3 files changed

+90
-33
lines changed

3 files changed

+90
-33
lines changed

apps/examples/nextjs/README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
> The example repository is maintained from a [monorepo](https://github.com/nextauthjs/next-auth/tree/main/apps/example-nextjs). Pull Requests should be opened against [`nextauthjs/next-auth`](https://github.com/nextauthjs/next-auth).
1+
> The example repository is maintained from a [monorepo](https://github.com/nextauthjs/next-auth/tree/main/apps/examples/nextjs). Pull Requests should be opened against [`nextauthjs/next-auth`](https://github.com/nextauthjs/next-auth).
22
33
<p align="center">
44
<br/>
5-
<a href="https://next-auth.js.org" target="_blank"><img width="150px" src="https://next-auth.js.org/img/logo/logo-sm.png" /></a>
6-
<h3 align="center">NextAuth.js Example App</h3>
5+
<a href="https://authjs.dev" target="_blank">
6+
<img height="64" src="https://authjs.dev/img/logo/logo-sm.png" />
7+
</a>
8+
<a href="https://nextjs.org" target="_blank">
9+
<img height="64" src="https://nextjs.org/static/favicon/android-chrome-192x192.png" />
10+
</a>
11+
<h3 align="center"><b>NextAuth.js</b> - Example App</h3>
712
<p align="center">
813
Open Source. Full Stack. Own Your Data.
914
</p>
@@ -25,20 +30,14 @@
2530

2631
## Overview
2732

28-
NextAuth.js is a complete open source authentication solution.
33+
NextAuth.js is a complete open-source authentication solution.
2934

3035
This is an example application that shows how `next-auth` is applied to a basic Next.js app.
3136

3237
The deployed version can be found at [`next-auth-example.vercel.app`](https://next-auth-example.vercel.app)
3338

34-
### About NextAuth.js
35-
36-
NextAuth.js is an easy to implement, full-stack (client/server) open source authentication library originally designed for [Next.js](https://nextjs.org) and [Serverless](https://vercel.com). Our goal is to [support even more frameworks](https://github.com/nextauthjs/next-auth/issues/2294) in the future.
37-
3839
Go to [next-auth.js.org](https://next-auth.js.org) for more information and documentation.
3940

40-
> _NextAuth.js is not officially associated with Vercel or Next.js._
41-
4241
## Getting Started
4342

4443
### 1. Clone the repository and install dependencies
@@ -98,15 +97,13 @@ npm run start
9897

9998
### 5. Preparing for Production
10099

101-
Follow the [Deployment documentation](https://next-auth.js.org/deployment)
100+
Follow the [Deployment documentation](https://authjs.dev/guides/basics/deployment) or deploy the example instantly using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-auth-example)
101+
102+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/nextauthjs/next-auth-example&project-name=next-auth-example&repository-name=next-auth-example)
102103

103104
## Acknowledgements
104105

105106
<a href="https://vercel.com?utm_source=nextauthjs&utm_campaign=oss">
106-
<img width="170px" src="https://raw.githubusercontent.com/nextauthjs/next-auth/canary/www/static/img/powered-by-vercel.svg" alt="Powered By Vercel" />
107+
<img width="170px" src="https://raw.githubusercontent.com/nextauthjs/next-auth/main/docs/static/img/powered-by-vercel.svg" alt="Powered By Vercel" />
107108
</a>
108-
<p align="left">Thanks to Vercel sponsoring this project by allowing it to be deployed for free for the entire NextAuth.js Team</p>
109-
110-
## License
111-
112-
ISC
109+
<p align="left">Thanks to Vercel sponsoring this project by allowing it to be deployed for free for the entire Auth.js Team</p>

apps/examples/solid-start/README.MD

Lines changed: 56 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,57 @@
1-
# Create JD App
1+
> The example repository is maintained from a [monorepo](https://github.com/nextauthjs/next-auth/tree/main/apps/examples/solid-start). Pull Requests should be opened against [`nextauthjs/next-auth`](https://github.com/nextauthjs/next-auth).
22
3-
This project was created using [Create JD App](https://github.com/OrJDev/create-jd-app)
3+
<p align="center">
4+
<br/>
5+
<a href="https://authjs.dev" target="_blank">
6+
<img height="64" src="https://authjs.dev/img/logo/logo-sm.png" />
7+
</a>
8+
<a href="https://start.solidjs.com" target="_blank">
9+
<img height="64" src="https://www.solidjs.com/assets/logo-123b04bc.svg" />
10+
</a>
11+
<h3 align="center"><b>SolidStart Auth</b> - Example App</h3>
12+
<p align="center">
13+
Open Source. Full Stack. Own Your Data.
14+
</p>
15+
<p align="center" style="align: center;">
16+
<a href="https://npm.im/@auth/solid-start">
17+
<img alt="npm" src="https://img.shields.io/npm/v/@auth/solid-start?color=green&label=@auth/solid-start&style=flat-square">
18+
</a>
19+
<a href="https://bundlephobia.com/result?p=@auth/solid-start">
20+
<img src="https://img.shields.io/bundlephobia/minzip/@auth/solid-start?label=size&style=flat-square" alt="Bundle Size"/>
21+
</a>
22+
<a href="https://www.npmtrends.com/@auth/solid-start">
23+
<img src="https://img.shields.io/npm/dm/@auth/solid-start?label=downloads&style=flat-square" alt="Downloads" />
24+
</a>
25+
<a href="https://npm.im/@auth/solid-start">
26+
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
27+
</a>
28+
</p>
29+
</p>
430

5-
## Deploying To Vercel
31+
## Overview
32+
33+
This is the official SolidStart Auth example for [Auth.js](https://authjs.dev).
34+
35+
36+
## Getting started
37+
38+
You can follow the guide below, or click the following button to deploy this example to [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=solid-start-auth-example).
39+
40+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/nextauthjs/solid-start-auth-example&project-name=solid-start-auth-example&repository-name=solid-start-auth-example)
641

742
### Installing
843

9-
```bash
10-
npm install solid-start-vercel@latest -D
44+
```sh
45+
pnpm add -D solid-start-vercel
46+
```
47+
```sh
48+
npm i -D solid-start-vercel
49+
```
50+
```sh
51+
yarn add -D solid-start-vercel
1152
```
1253

13-
### Adding to vite config
54+
### Adding to Vite config
1455

1556
```ts
1657
import solid from "solid-start/vite";
@@ -32,6 +73,13 @@ export default defineConfig(() => {
3273

3374
- `ENABLE_VC_BUILD`=`1` .
3475

35-
### You Are Done
76+
### Finishing up
77+
78+
Create a GitHub repo and push the code to it, then deploy it to Vercel.
79+
80+
## Acknowledgements
3681

37-
Create a github repo and push your code to it, then deploy it to vercel (:
82+
<a href="https://vercel.com?utm_source=nextauthjs&utm_campaign=oss">
83+
<img width="170px" src="https://raw.githubusercontent.com/nextauthjs/next-auth/main/docs/static/img/powered-by-vercel.svg" alt="Powered By Vercel" />
84+
</a>
85+
<p align="left">Thanks to Vercel sponsoring this project by allowing it to be deployed for free for the entire Auth.js Team</p>

apps/examples/sveltekit/README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,40 @@
1-
> The example repository is maintained from a [monorepo](https://github.com/nextauthjs/next-auth/tree/main/apps/example-sveltekit). Pull Requests should be opened against [`nextauthjs/next-auth`](https://github.com/nextauthjs/next-auth).
1+
> The example repository is maintained from a [monorepo](https://github.com/nextauthjs/next-auth/tree/main/apps/examples/sveltekit). Pull Requests should be opened against [`nextauthjs/next-auth`](https://github.com/nextauthjs/next-auth).
22
33
<p align="center">
44
<br/>
5-
<a href="https://authjs.dev" target="_blank"><img width="150px" src="https://authjs.dev/img/logo/logo-sm.png" /></a>
6-
<h3 align="center">Auth.js Example App with <a href="https://kit.svelte.dev">SvelteKit</a></h3>
5+
<a href="https://authjs.dev" target="_blank">
6+
<img height="64" src="https://authjs.dev/img/logo/logo-sm.png" />
7+
</a>
8+
<a href="https://kit.svelte.dev" target="_blank">
9+
<img height="64" src="https://upload.wikimedia.org/wikipedia/commons/1/1b/Svelte_Logo.svg" />
10+
</a>
11+
<h3 align="center"><b>SvelteKit Auth</b> - Example App</h3>
712
<p align="center">
813
Open Source. Full Stack. Own Your Data.
914
</p>
1015
<p align="center" style="align: center;">
1116
<a href="https://npm.im/@auth/sveltekit">
1217
<img alt="npm" src="https://img.shields.io/npm/v/@auth/sveltekit?color=green&label=@auth/sveltekit&style=flat-square">
1318
</a>
14-
<a href="https://bundlephobia.com/result?p=sveltekit-auth-example">
19+
<a href="https://bundlephobia.com/result?p=@auth/sveltekit">
1520
<img src="https://img.shields.io/bundlephobia/minzip/@auth/sveltekit?label=size&style=flat-square" alt="Bundle Size"/>
1621
</a>
1722
<a href="https://www.npmtrends.com/@auth/sveltekit">
18-
<img src="https://img.shields.io/npm/dm/@auth/sveltekit?label=%20downloads&style=flat-square" alt="Downloads" />
23+
<img src="https://img.shields.io/npm/dm/@auth/sveltekit?label=downloads&style=flat-square" alt="Downloads" />
1924
</a>
20-
<a href="https://npm.im/next-auth">
25+
<a href="https://npm.im/@auth/sveltekit">
2126
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
2227
</a>
2328
</p>
2429
</p>
2530

26-
# Documentation
31+
## Overview
32+
33+
This is the official SvelteKit Auth example for [Auth.js](https://sveltekit.authjs.dev).
34+
35+
36+
## Getting started
37+
38+
You can instantly deploy this example to [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=sveltekit-auth-example) by clicking the following button.
2739

28-
- [sveltekit.authjs.dev](https://sveltekit.authjs.dev)
40+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/nextauthjs/sveltekit-auth-example&project-name=sveltekit-auth-example&repository-name=sveltekit-auth-example)

0 commit comments

Comments
 (0)