https://github.com/nerdo/whogoesthere
A small app demo using SurrealDB
https://github.com/nerdo/whogoesthere
Last synced: 12 months ago
JSON representation
A small app demo using SurrealDB
- Host: GitHub
- URL: https://github.com/nerdo/whogoesthere
- Owner: nerdo
- Created: 2023-10-09T04:47:09.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T17:29:54.000Z (almost 3 years ago)
- Last Synced: 2025-03-12T23:30:27.226Z (over 1 year ago)
- Language: TypeScript
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Who Goes There?
A simple, sample app using SurrealDB as a backend.
## Prerequisites
* [pnpm](https://pnpm.io)
* [SurrealDB](https://surrealdb.com )
* [ngrok](https://ngrok.io) (optional)
## Quick Start
1. Run `pnpm install` to install dependencies.
2. Start the dev server with `pnpm dev`. This should concurrently start SurrealDB and the dev server.
## ngrok dev mode
To make the server publicly available in dev mode.
1. Run `pnpm install` to install dependencies.
3. Copy `.env.example` to `.env`. Edit...
* `NGROK_AUTHTOKEN` - Your ngrok authentication token.
* `NGROK_SUBDOMAIN` - A unique ngrok subdomain for your app to run on.
4. Start the dev server with `pnpm dev:ngrok`. This should start SurrealDB, ngrok, and the dev server concurrently.
5. Point your web browser to `https://NGROK_SUBDOMAIN.ngrok.io` where `NGROK_SUBDOMAIN` is the value you set in the `.env` file.