Treeckle 3.0

Website: https://treeckle.com/

Currently in production

Treeckle is a student life app for the Residential Colleges of NUS, intended to be a platform for the efficient booking of facilties, and the creation and management of events.

For usage/contribution, please contact @JermyTan

Contributions Guidelines

Commits/PR

• Use squash and merge
• PR by issue/feature
• Use github issues

Backend

• Use venv
• Style
• Use snake_case, 4 spaces indentations and CONSTANT_VARIABLE
• Use list comphension
• Include constant file
• Use double quotes for strings

Frontend

• Only use yarn (no npm)
• Typescript only in src file
• Component files use tsx, utils function files use ts
• Define constants instead of magic string
• Use enums
• Declare API response type

🏗️ Architecture

Technology Stack

• Frontend: React + TypeScript + Vite + Semantic UI React + Redux Toolkit
• Backend: Django + Django REST Framework + PostgreSQL
• Infrastructure: Docker + Nginx reverse proxy
• Authentication: JWT tokens with Google/Facebook OAuth support

Project Structure

treeckle-3.0/
├── frontend/          # React TypeScript application
├── backend/           # Django REST API
├── app-reverse-proxy/ # Nginx reverse proxy configuration
├── core-reverse-proxy/# Core nginx configuration
└── assets/            # Project assets and branding

🚀 Quick Start

Prerequisites

• Docker and Docker Compose
• Node.js 16+ (for local frontend development)
• Python 3.9+ (for local backend development)

Development Setup

See the detailed developer guides:

• Frontend Development Guide
• Backend Development Guide