Skip to content

evanschoffstall/Immerse

Repository files navigation

Immerse

Build Worlds. Tell Stories. Create Legends.

A comprehensive RPG campaign management platform designed for game masters and storytellers to organize tabletop roleplaying game campaigns.

✨ Features

This project is currently in active development. Core features and functionality are being implemented.

🛠️ Tech Stack

  • Framework: Next.js 15 with Turbo
  • Language: TypeScript (strict mode)
  • UI: React 19, Radix UI, TailwindCSS 4
  • Database: PostgreSQL with Drizzle ORM
  • Authentication: NextAuth.js
  • Editor: Lexical (Meta's rich text framework)
  • Forms: React Hook Form + Zod validation
  • Image Processing: Sharp

🚀 Getting Started

📋 Prerequisites

  • Node.js 18+ (or Bun for faster performance)
  • PostgreSQL installed and running

📦 Installation

  1. Clone the repository
git clone <repository-url>
cd Immerse
  1. Install dependencies
npm install
# or with bun: bun install

Note: Ensure PostgreSQL is installed on your system. See the PostgreSQL installation guide for your platform.

  1. Set up environment variables
# Create .env.local file with:
DATABASE_URL=your_postgresql_connection_string
NEXTAUTH_SECRET=your_secret_key
NEXTAUTH_URL=http://localhost:3000
  1. Initialize the database
npm run db:generate
npm run db:migrate
  1. Start the development server and postgres
./run

The application will be available at http://localhost:3000

📄 License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0).

🤝 Contributing

Contributions are welcome. Please consider opening an issue first to discuss proposed changes before preparing a pull request.

About

A comprehensive RPG campaign management platform designed for game masters and storytellers to organize tabletop roleplaying game campaigns.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages