Udaan is a tool built for schools to help create, organise, and conduct online lessons for their students while keeping them engaged. It makes distance learning more immersive by providing them with a custom built virtual school. Students attend classes as custom characters and access their lesson notes and other data from the library. Teachers are provided with highly intuitive educational tools to seamlessly collaborate with their students.

Table of Contents

• Tech Stack
• Features
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License

Tech Stack

Primary

Other
Phaser Colyseus

Features

Secure login for students and teachers.

Interactive virtual school in 2D graphics

Ability to Create lessons and conduct them using interactive white boards

Ability to take down notes and review them later

Getting Started

Prerequisites

Basic knowledge of the following technologies:

• Node.js
• Node Package Manager
• PostgreSQL

Installation

Steps

1. Clone the git repository to local machine

2. Install dependencies
   From / run npm i then npm run install-all-deps to install all dependecies

3. Setup env variables
   Create .env files in /server and /client (see examples .env-example)

4. Database
   You will need a database running on your local machine. Add access details to /server/.env
   Database UI: From / run npm run db-ui

5. Start
   Start client and server: From / run dev environment: npm run start

Contributing

Udaan is an open-source application; contributions welcome.

Development

Git

Commit

npm run commit
Linter will run and then Commitizen

Backend

Mock data

Seed the database with mock data In /server run npx ts-node dataGenerate.ts

Linter

Run linter on /server and /client

npm run lint

Run linter on /server

npm run lint:server

Run linter on /client

npm run lint:client

Auto-fix

Auto-fix linting issues /server and /client

npm run lint:fix

Auto-fix linting issues on /server

npm run lint:fix:server

Auto-fix linting issues on /client

npm run lint:fix:client