Nuspace.kz

The superapp for NU students, offering campus services, announcements, and student essentials in one trusted, convenient platform.

Table of Contents

• Nuspace.kz
  • Tech Stack
  • Features
  • Prerequisites
  • Quick Start
  • Development
  • Documentation
  • Contributing
  • License
  • Contact

Tech Stack

Backend

Frontend

DevOps & Infrastructure

Features

• 🔐 Secure Authentication - Email verification via @nu.edu.kz domain
• 💬 Student Communication Platform - Centralized messaging and community management
• 🤖 Telegram Bot Integration - Seamless bot functionality with localization
• 📱 Modern Web Interface - Responsive React-based frontend
• 🚀 Scalable Architecture - Microservices with async task processing
• 📊 Real-time Notifications - Instant updates and alerts
• 🎯 Community Management - Tools for organizing student groups and events

Prerequisites

Before setting up the project, ensure you have the following installed:

• Docker
• Git

Quick Start

1. Clone the Repository

git clone https://github.com/ulanpy/nuspace.git
cd nuspace/infra

2. Configure Environment Variables

Create a .env file using the provided example:

cp .env.example .env

Important: Add your TELEGRAM_BOT_TOKEN (create a bot through @BotFather if needed).

3. Build and Run

Start the application using Docker Compose:

# syntax from Compose v2.0 and above
docker compose up --build

# If older version try
docker-compose up --build

4. Verify Setup

Access the application at localhost to confirm everything is running correctly.

Development

Pre-commit Hooks (Recommended)

Set up pre-commit hooks for code quality:

# Create virtual environment (if needed)
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install pre-commit
pip install pre-commit
pre-commit install

Development Guidelines

• Always use pre-commit to ensure code quality
• Follow the contribution guidelines for submitting pull requests
• Test your changes thoroughly before submitting

Documentation

• Workload Identity Federation - GitHub Actions authentication with GCP for CI/CD pipeline
• Monitoring Guide - What monitoring service stack is used and their connection details
• Terraform Setup - Provision cloud services for stage/production environments by IoC
• WireGuard VPN - Secure VPN access to monitoring tools and internal services

Contributing

We welcome contributions! Please read the CONTRIBUTING.md file for detailed guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or support, reach out to:

• Email: ulan.sharipov@nu.edu.kz
• Nuspace dev chat: https://t.me/nuspacedevcommunity