https://github.com/arithefirst/johndex
The greatest database of Johns in history
https://github.com/arithefirst/johndex
Last synced: 5 months ago
JSON representation
The greatest database of Johns in history
- Host: GitHub
- URL: https://github.com/arithefirst/johndex
- Owner: arithefirst
- License: gpl-3.0
- Created: 2025-03-20T21:14:13.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2025-04-29T17:11:56.000Z (9 months ago)
- Last Synced: 2025-07-14T10:47:30.490Z (7 months ago)
- Language: Svelte
- Homepage: https://jdx.arithefirst.com
- Size: 483 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The greatest database of Johns in history
---
## Setup Guide
### Prerequisites
- [Node.js](https://nodejs.org/) (v18 or newer)
- [Bun](https://bun.sh/) or npm
- PostgreSQL database (we use [Neon](https://neon.tech/))
- [Clerk](https://clerk.dev/) account for authentication
### Installation
1. Clone the repository
```bash
git clone https://github.com/arithefirst/johndex.git
cd johndex
```
2. Install dependencies
```bash
bun install
# OR
npm install
```
### Environment Setup
1. Copy the example environment file
```bash
cp .env.example .env
```
2. Configure your environment variables:
- Create a database on [Neon](https://neon.tech/) and add your connection string to [`DATABASE_URL`](drizzle.config.ts)
- Create a project on [Clerk](https://clerk.dev/) and add your API keys:
- Add `PUBLIC_CLERK_PUBLISHABLE_KEY` from your Clerk dashboard
- Add `CLERK_SECRET_KEY` from your Clerk dashboard
### Database Setup
Run the database migrations:
```bash
bun db:migrate
# OR
npm run db:migrate
```
For development with a UI to explore your database:
```bash
bun db:studio
# OR
npm run db:studio
```
### Development
Start the development server:
```bash
bun dev
# OR
npm run dev
```
### Production Build
Build for production:
```bash
bun build
# OR
npm run build
```
Preview the production build:
```bash
bun preview
# OR
npm run preview
```