Tutly

Learning Management System (LMS) with attendance tracking, assignment management, interactive code playgrounds, real-time notifications, and many more.

Links

• 🏠 Landing Page: https://www.tutly.in
• 📚 Learning Platform: https://learn.tutly.in
• 📄 Documentation: https://docs.tutly.in
• 📊 Status: https://tutly.statuspage.io/

Project Structure

.github
  └─ workflows
        └─ CI with pnpm cache setup
.vscode
  └─ Recommended extensions and settings for VSCode users
apps
  └─ web
      ├─ Next.js 15
      ├─ React 19
      └─ Tailwind CSS v4
packages
  ├─ api
  |   └─ tRPC v11 router definition
  ├─ auth
  |   └─ Custom authentication
  ├─ db
  |   └─ Typesafe db calls using Prisma
  ├─ ui
  |   └─ UI components using shadcn-ui
  └─ validators
      └─ Shared validation schemas
tooling
  ├─ eslint
  |   └─ shared, fine-grained, eslint presets
  ├─ prettier
  |   └─ shared prettier configuration
  ├─ tailwind
  |   └─ shared tailwind configuration
  └─ typescript
      └─ shared tsconfig you can extend from

Getting Started

Prerequisites

• Node.js (version specified in .nvmrc)
• pnpm

Installation and Development Setup

1. Fork the repository
2. Clone your forked repository

git clone https://github.com/yourusername/tutly.git
cd tutly

3. Set up the development environment

make up

This will:

• Copy the example environment file to .env
• Install all dependencies
• Set up local Docker services (PostgreSQL and Localstack for S3)
• Initialize the database schema
• Load initial dummy data

4. Start the development server

make dev

The development server will be running at http://localhost:3000

Useful Commands

# Start the development server
make dev

# Open Prisma Studio for database management
make studio

# Stop all services
make down

# Clean all services, volumes, and .env
make clean

# Re-initialize the project (after cleaning)
make init

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.

The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.

Key points of the license:

• You are free to use and modify the software for personal use
• Distribution of the software is not permitted
• You must preserve the license and copyright notices
• You must state significant changes made to the code
• The license applies to the entire work, including all its parts

For more information about the license, visit https://www.gnu.org/licenses/agpl-3.0.html