InstaQuiz

Sample bot   •   Documentation   •   Issues

What is InstaQuiz?

InstaQuiz (Instant Quiz) is a real-time multiplayer quiz game made for Telegram Mini App platform. Players can create quiz rooms and invite friends to join for fast-paced trivia fun. The app is built using Typescript, Express.js, Postgresql and Vue.js.

You can see an example bot: InstaQuiz bot

You can read the documentation at here or go to Quick links section and read right here on Github.

Requirements

Git and Github, Node, PNPM and an IDE.

Setup

Follow below instructions to setup the code.

Clone

git clone https://github.com/yasdpt/insta-quiz.git

cd insta-quiz

Server setup

# from root folder
cd server

# install server dependencies
pnpm install

# create environment variables and replace them with your own values
cp .env.example .env

Client setup

#from root folder
cd client

# install client dependencies
pnpm install

# Create environment variables
cp .env.example .env

# env for production run
cp .env.example .env.production

More

For complete documentation follow links below

Quick links

• Intro
  • Introduction
• Setup
  • Requirements
  • Environment setup
  • Testing
• Database
  • Schema
  • Setup
• Server
  • Folder structure
  • Code structure
  • API reference
• Client
  • Folder structure
  • Code structure
• Deployment
  • Your own server
  • Fly.io

License

This project is licensed under the GPL-3.0 license.