jusemon/unreal-chat
1
0
Fork 0
Code Pull requests Releases Packages Activity Actions
unreal-chat/apps/api
History
Juan Sebastian Montoya c737258aed feat: enhance room management and UI with join/leave functionality 
- Added GraphQL mutations and subscriptions for joining and leaving rooms
- Implemented room member tracking and display in room list
- Added leave room confirmation and error handling in chat room
- Updated room list and chat room components with new interaction features
- Improved UI with member badges, join/leave buttons, and error messages
- Enhanced room query to include member information
2025-03-04 01:46:30 -05:00
..
prisma refactor: migrate from Next.js to SolidJS and GraphQL 2025-03-04 01:08:52 -05:00
src feat: enhance room management and UI with join/leave functionality 2025-03-04 01:46:30 -05:00
.dockerignore refactor: migrate from Next.js to SolidJS and GraphQL 2025-03-04 01:08:52 -05:00
.gitignore refactor: migrate from Next.js to SolidJS and GraphQL 2025-03-04 01:08:52 -05:00
Dockerfile refactor: migrate from Next.js to SolidJS and GraphQL 2025-03-04 01:08:52 -05:00
package.json refactor: migrate from Next.js to SolidJS and GraphQL 2025-03-04 01:08:52 -05:00
README.md refactor: migrate from Next.js to SolidJS and GraphQL 2025-03-04 01:08:52 -05:00
tsconfig.json refactor: migrate from Next.js to SolidJS and GraphQL 2025-03-04 01:08:52 -05:00

README.md

Unreal Chat API

The backend API for the Unreal Chat application, built with Apollo Server, GraphQL, and Prisma.

Features

  • GraphQL API with Apollo Server
  • Real-time subscriptions for messages and rooms
  • Prisma ORM with MariaDB
  • User authentication
  • Chat rooms and messaging

Getting Started

Prerequisites

  • Node.js (v18 or later)
  • npm (v10 or later)
  • MariaDB or MySQL

Installation

  1. Install dependencies:
npm install
  1. Set up the database:

Make sure you have MariaDB running and update the connection string in prisma/.env if needed.

  1. Run Prisma migrations:
npm run prisma:migrate
  1. Start the development server:
npm run dev

The API will be available at http://localhost:4000/graphql.

Available Scripts

  • npm run dev - Start the development server
  • npm run build - Build the application
  • npm run start - Start the production server
  • npm run prisma:generate - Generate Prisma client
  • npm run prisma:migrate - Run Prisma migrations
  • npm run prisma:studio - Open Prisma Studio

API Documentation

Authentication

For development purposes, authentication is simplified. In a production environment, you would use JWT tokens.

GraphQL Schema

The GraphQL schema includes the following main types:

  • User: Represents a user in the system
  • Room: Represents a chat room
  • Message: Represents a message in a chat room

Queries

  • me: Get the current user
  • users: Get all users
  • user(id: ID!): Get a user by ID
  • rooms: Get all public rooms
  • room(id: ID!): Get a room by ID
  • messages(roomId: ID!): Get messages in a room

Mutations

  • register(email: String!, username: String!, password: String!): Register a new user
  • login(email: String!, password: String!): Login a user
  • createRoom(name: String!, description: String, isPrivate: Boolean): Create a new room
  • joinRoom(roomId: ID!): Join a room
  • leaveRoom(roomId: ID!): Leave a room
  • sendMessage(content: String!, roomId: ID!): Send a message to a room

Subscriptions

  • messageAdded(roomId: ID!): Subscribe to new messages in a room
  • roomAdded: Subscribe to new rooms