update documentation for root

Author: ivinjabraham

README.md

@@ -1,24 +1,80 @@
 <div align="center">
   <h1>Root</h1>
-  <p>a backend to manage all club information</p>
+  <p>A GraphQL backend for managing club member information</p>
 </div>
 
-### Overview
-**Root** is a backend for managing all club related info; most other projects will be getting or publishing their data to root.
+---
 
-### Documentation
+Root is our club's backend, responsible for collecting and distributing data from and to all the other services including [Home](https://www.github.com/amfoss/home), [amD](https://www.github.com/amfoss/amd) and [Presense](https://www.github.com/amfoss/presense). The idea is to have all our data easily available in one place and to let every other end-user applications to be standalone. This ensures there's no single point of failure for all our infrastructure (as was the case with our previous CMS). Though Root going down would definitely cause a few features to stop working on the other apps.
 
-Explore the [Documentation](/docs/docs.md) for detailed information and usage guidelines.
+# Quick Setup
 
----
+1. Install prerequisites:
+   - Rust (latest stable should work fine)
+   - PostgreSQL
+   - SQLx CLI: `cargo install sqlx-cli`
+
+2. Configure environment:
+   ```bash
+   touch .env
+   ```
+
+The following environment variables are required:
+* DATABASE_URL: Connection string to your DB.
+* RUST_ENV: Use "development" or "production" as applicable.
+* ROOT_SECRET: Used to verify the origin of mutation requests on attendance. Ask the maintainers for it.
+* BIND_ADDRESS: The IP address for `axum` to serve to. Typically `0.0.0.0:3000` for local deployments.
+
+3. Setup database:
+   ```bash
+   sqlx database create
+   sqlx migrate run
+   ```
+
+4. Run server:
+   ```bash
+   cargo run
+   ```
+
+GraphQL playground should be available at `http://localhost:8000/graphiql` as long as it's in development mode.
+
+# Documentation
+
+See the [documentation](docs/docs.md) for the API reference, database schema and other detailed documentation.  
+
+# Contributing
+
+## Reporting Issues
+
+If you encounter a bug, please check existing issues first to avoid duplicates. If none exist, create a new issue with the following details:
+
+*  Title: Concise summary.
+* Description: A detailed description of the issue.
+*  Steps to Reproduce: If it's a bug, include steps to reproduce.
+* Expected and Actual Behavior: Describe what you expected and what actually happened.
+
+## Suggesting Features
+
+We welcome new ideas! Please open an issue titled "Feature Request: `<Feature Name>`" and provide:
+
+* Problem: What problem does this feature solve?
+* Solution: Describe how you envision it working.
+* Alternatives Considered: Mention any alternatives you've considered.
+
+## Submitting Code Changes
+
+If you'd like to fix a bug, add a feature, or improve code quality:
+
+* Check the open issues to avoid redundancy.
+* Open a draft PR if you'd like feedback on an ongoing contribution.
+
+## Coding Standards
 
-### How to Contribute
+* Follow Rust Conventions: Use idiomatic Rust patterns. Use `cargo fmt` and `cargo clippy` to format and lint your code.
+* Modularity: Write modular, reusable functions. Avoid monolithic code.
+* Descriptive Naming: Use descriptive names for variables, functions, and types.
+* Don't worry too much about rules, it just needs to be pretty. Most editors have built-in tools to do this for you. 
 
-1. Fork the repository and clone it to your local machine.
-2. Set up the project by following the installation instructions above.
-3. Identify an issue or feature you'd like to work on, and create an issue to track it.
-4. Develop the patch or feature, ensuring it is thoroughly tested.
-5. Submit a pull request, referencing the relevant issue number.
+# License
 
-### License
 This project is licensed under GNU General Public License V3. You are welcome to adapt it, make it yours. Just make sure that you credit us too.

docs/attendance.md

@@ -0,0 +1,71 @@
+# Attendance System
+
+Track daily member attendance and generate monthly attendance summaries. The summaries are used for quick access to see how many days a member has attended in a specific month, used in the amD attendance report.
+
+## Models
+
+### Attendance
+```rust
+struct Attendance {
+    attendance_id: i32,
+    member_id: i32,
+    date: NaiveDate,
+    is_present: bool,
+    time_in: Option<NaiveTime>,
+    time_out: Option<NaiveTime>,
+    created_at: NaiveDateTime,
+    updated_at: NaiveDateTime,
+}
+```
+The final two fields are not exposed in the interface for obvious reasons.
+
+### AttendanceSummary
+Monthly attendance summary for each member.
+```rust
+struct AttendanceSummary {
+    member_id: i32,
+    year: i32,
+    month: i32,
+    days_attended: i32,
+}
+```
+
+## Queries
+
+### Mark Attendance
+Record a member's attendance for the day.
+
+```graphql
+mutation {
+    markAttendance(
+        input: {
+            memberId: 1
+            date: "2025-01-15"
+            timeIn: "09:00:00"
+            timeOut: "17:00:00"
+        }
+    ) {
+        attendanceId
+        isPresent
+        timeIn
+        timeOut
+    }
+}
+```
+
+### Get Attendance Summary
+Get monthly attendance summary for a member.
+
+```graphql
+query {
+    attendanceSummary(memberId: 1) {
+        year
+        month
+        daysAttended
+    }
+}
+```
+
+## Daily Task
+
+The `src/daily_task/daily_task.rs` system automatically updates attendance summaries at midnight.

docs/database.md

@@ -0,0 +1,77 @@
+# Database Migrations
+
+## Overview
+Database schema is managed using SQLx migrations. Do not tamper with the database yourself (using clients such as psql) or with the migrations files.
+
+## Current Schema
+
+The entire schema, including constraints, is visible in `migrations/`.
+
+### Member Table
+```sql
+CREATE TABLE Member (
+    member_id SERIAL PRIMARY KEY,
+    roll_no VARCHAR NOT NULL UNIQUE,
+    name VARCHAR NOT NULL,
+    email VARCHAR NOT NULL UNIQUE,
+    sex sex_type NOT NULL,
+    year INT NOT NULL,
+    hostel VARCHAR NOT NULL,
+    mac_address VARCHAR NOT NULL,
+    discord_id VARCHAR NOT NULL,
+    group_id INT NOT NULL,
+    created_at TIMESTAMP NOT NULL
+);
+```
+
+### Attendance Table
+```sql
+CREATE TABLE Attendance (
+    attendance_id SERIAL PRIMARY KEY,
+    member_id INT REFERENCES Member(member_id),
+    date DATE NOT NULL,
+    is_present BOOLEAN NOT NULL,
+    time_in TIME,
+    time_out TIME,
+    created_at TIMESTAMP NOT NULL,
+    updated_at TIMESTAMP NOT NULL
+);
+```
+
+### AttendanceSummary Table
+```sql
+CREATE TABLE AttendanceSummary (
+    member_id INT REFERENCES Member(member_id),
+    year INT NOT NULL,
+    month INT NOT NULL,
+    days_attended INT NOT NULL DEFAULT 0,
+    PRIMARY KEY (member_id, year, month)
+);
+```
+
+### StatusUpdateStreak Table
+```sql
+CREATE TABLE StatusUpdateStreak (
+    member_id INT REFERENCES Member(member_id),
+    current_streak INT NOT NULL DEFAULT 0,
+    max_streak INT NOT NULL,
+    PRIMARY KEY (member_id)
+);
+```
+
+## Managing Migrations
+
+### Create Migration
+```bash
+sqlx migrate add <migration_name>
+```
+
+### Run Migrations
+```bash
+sqlx migrate run
+```
+
+### Revert Migration
+```bash
+sqlx migrate revert
+```

docs/docs.md

@@ -1,6 +1,33 @@
-# API Documentation
+# Root Documentation
 
-## Contents
-- [Managing Migrations](/docs/migrations.md)
-- [GraphQL Queries](/docs/queries.md)
-- [GraphQL Mutations](/docs/mutations.md)
+## Project Structure
+```
+src/
+├── graphql/        # GraphQL schema definitions
+│   ├── mutations/  # Data modification operations
+│   └── queries/    # Data retrieval operations
+├── models/         # Database models and types
+├── daily_task/     # Self explanatory
+└── routes.rs       # HTTP routing setup
+```
+
+## GraphQL API Structure
+- [Member Management](member.md) - Managing club member profiles
+- [Attendance System](attendance.md) - Daily attendance tracking and summaries  
+- [Status Streaks](streaks.md) - Tracking daily status update streaks
+
+## Database Schema
+- [Database](database.md) - Database structure and migrations
+
+## Core Features
+### Member Management
+- Query members by ID, roll number, or Discord ID
+- Create and update member profiles
+
+### Attendance System  
+- Mark daily attendance with time tracking
+- Generate monthly attendance summaries
+
+### Status Updates
+- Track daily status update streaks
+- Record maximum streaks achieved

docs/member.md

@@ -0,0 +1,62 @@
+# Member Management
+
+Manage club member profiles. This is the central entity for the database. Most things should relate to one or more members.
+
+## Models
+
+### Member
+```rust
+struct Member {
+    member_id: i32,
+    roll_no: String,
+    name: String,
+    email: String,
+    sex: Sex,
+    year: i32,
+    hostel: String,
+    mac_address: String,
+    discord_id: String,
+    group_id: i32,
+}
+```
+
+## Queries
+
+### Get Member
+Retrieve member details by ID, roll number, or Discord ID.
+
+```graphql
+query {
+    getMember(rollNo: "AM.XX.U4XXX") {
+        name
+        email
+        year
+    }
+}
+```
+
+## Mutations
+
+### Create Member
+Add a new member to the database.
+
+```graphql
+mutation {
+    createMember(
+        input: {
+            rollNo: "AM.XX.U4XXX"
+            name: "John Doe"
+            email: "john@amfoss.in"
+            sex: "M"
+            year: 2
+            hostel: "MH"
+            macAddress: "XX:XX:XX:XX:XX:XX"
+            discordId: "123456789"
+            groupId: 1
+        }
+    ) {
+        memberId
+        name
+    }
+}
+```