Skip to content

Commit b87e315

Browse files
committed
Update readme
1 parent 9a36782 commit b87e315

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,34 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
# Plain headless portal
22

3-
## Getting Started
3+
This is a minimally styled example [Next.js](https://nextjs.org/) project demonstrating how you can use the Plain API to create a custom support portal. In the portal your customers can log in to:
44

5-
First, run the development server:
5+
- Raise new support requests
6+
- View requests raised by anyone in their tenant
67

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
8+
## Getting Started
169

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
10+
In order to use this example you first need to have a workspace set up with [Plain](https://www.plain.com/) on at least the [Grow plan](https://www.plain.com/pricing).
1811

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
12+
Now you will need to create an API key for the support portal backend to authenticate with Plain.
2013

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
14+
- Log in to Plain and go to `Settings -> Machine users`
15+
- Click `Add machine user` and fill in the details
16+
- You should be taken to your machine user, now click `Add API key`
17+
- TODO p-7884: create minimal set of perms and copy mechanism
2218

23-
## Learn More
19+
Once you have your key you can get started:
2420

25-
To learn more about Next.js, take a look at the following resources:
21+
```bash
22+
npm install
23+
PLAIN_API_KEY=<your_key> npm run dev
24+
```
2625

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
26+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
2927

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
28+
## Screenshots
3129

32-
## Deploy on Vercel
30+
![View the list of requests](/screenshots/thread-list.png)
3331

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
32+
![See the details of a support request](/screenshots/thread-page.png)
3533

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
34+
![Create a new support request](/screenshots/new-request.png)

0 commit comments

Comments
 (0)