Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chtozamm/guestbook
A guestbook that could be signed by an authenticated user and viewed by other guests.
https://github.com/chtozamm/guestbook
Last synced: 21 days ago
JSON representation
A guestbook that could be signed by an authenticated user and viewed by other guests.
- Host: GitHub
- URL: https://github.com/chtozamm/guestbook
- Owner: chtozamm
- Created: 2024-06-17T17:22:38.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T22:02:26.000Z (7 months ago)
- Last Synced: 2024-06-18T19:56:05.645Z (7 months ago)
- Language: TypeScript
- Homepage: https://guestbook-pearl.vercel.app
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Guestbook
A guestbook that could be signed by an authenticated user and viewed by other guests.
Inspired by [Lee Robinson's Guestbook](https://leerob.io/guestbook).
## Features
- Authentication: [Auth.js](https://authjs.dev/)
- Database: [Xata](https://xata.io/)
- Color scheme: [Nord](https://www.nordtheme.com/)
- Toast notifications: [Sonner](https://sonner.emilkowal.ski/)## Setting up
### Install the dependencies
```bash
pnpm install
```### Database
Make sure to [initialize Xata](https://xata.io/docs/getting-started/nextjs) first.
After initializing Xata, you should have the following environmental variables added to your `.env.local`:
- XATA_BRANCH=
- XATA_API_KEY=### Authentication
Follow [the guide](https://authjs.dev/guides/configuring-github) to configure OAuth with GitHub.
You should have the following environmental variables set:
- AUTH_SECRET=
- AUTH_GITHUB_ID=
- AUTH_GITHUB_SECRET=### Start the application
Run the development server:
```bash
pnpm dev
```or build the application:
```bash
pnpm build && pnpm start
```## Resources
- [Xata Database](https://xata.io/docs/getting-started/nextjs)
- [OAuth with GitHub](https://authjs.dev/guides/configuring-github)