🚀 InkBoard

COP 4331 – Large Project | University of Central Florida

---

👥 Team Members

Name	Role
[Name 1]	Frontend / React
[Name 2]	Backend / Express API
[Name 3]	Mobile / Flutter
[Name 4]	Database / MongoDB
[Name 5]	DevOps / Deployment

---

📖 Project Description

[Describe your project here — what it does, who it's for, and why you built it.]

---

🛠️ Tech Stack

Frontend

• React (TypeScript) — component-based UI
• Bootstrap / Tailwind CSS — responsive styling
• AJAX — asynchronous API communication

Backend

• Node.js + Express — RESTful API server
• JWT (JSON Web Tokens) — authentication & security
• SendGrid / NodeMailer — email verification & password reset

Database

• MongoDB (remote) — document-based NoSQL database

Mobile

• Flutter — cross-platform iOS & Android app

DevOps & Hosting

• [Heroku / Digital Ocean / AWS / Azure / GoDaddy] — remote hosting
• Domain Name: https://your-domain.com
• GitHub — source control & collaboration

---

✨ Features

• 🔐 User Authentication — JWT-secured login/logout
• 📧 Email Verification — account confirmation on signup
• 🔑 Password Recovery — forgot-password email flow
• 📱 Mobile App — cross-platform Flutter application
• 🌐 Web App — fully AJAX-enabled React frontend
• 🔍 Live Search — single-keypress round-trip server queries
• 📄 Pagination — efficient data browsing
• 🗑️ Delete Confirmation — single alert-box confirmation UX

---

🏗️ Architecture & Documentation

Document	Link
📊 Gantt Chart	View
🗂️ ERD (Entity Relationship Diagram)	View
📋 Use Case Diagram	View
🔄 Activity / Sequence Diagram	View
📐 Class Diagram (Mobile)	View
🖼️ Prototypes / Wireframes (Figma)	View
🔆 Lighthouse Report	View
📡 SwaggerHub API Docs	View
✅ Unit & Integration Test Results	View

---

📡 API

Full API documentation is available on SwaggerHub:
🔗 SwaggerHub API Docs

The API uses JSON for all client-server communication.

Sample Endpoints

GET    /api/[resource]        - Get all items
POST   /api/[resource]        - Create a new item
GET    /api/[resource]/:id    - Get item by ID
PUT    /api/[resource]/:id    - Update item by ID
DELETE /api/[resource]/:id    - Delete item by ID

---

🚀 Getting Started

Prerequisites

• Node.js v16+
• npm or yarn
• MongoDB Atlas account (or local instance for dev)
• Flutter SDK (for mobile)

Installation

# Clone the repository
git clone https://github.com/your-org/your-repo.git
cd your-repo

Backend

cd server
npm install
cp .env.example .env   # Fill in your environment variables
npm start

Frontend

cd client
npm install
npm start

Mobile (Flutter)

cd mobile
flutter pub get
flutter run

Environment Variables

Create a .env file in /server with the following:

MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret
SENDGRID_API_KEY=your_sendgrid_key
PORT=5000

---

🧪 Testing

# Run unit & integration tests
cd server
npm test

Test results and coverage reports are available in /docs/test-results.

---

📁 Project Structure

├── client/          # React (TypeScript) frontend
├── server/          # Node.js + Express API
├── mobile/          # Flutter mobile app
├── docs/            # Diagrams, wireframes, test results
│   ├── gantt/
│   ├── erd/
│   ├── use-case/
│   ├── wireframes/
│   └── test-results/
└── README.md

---

📝 Reflections

✅ What Went Well

• [e.g., Team communication via Discord]
• [e.g., API design and SwaggerHub integration]
• [e.g., Flutter cross-platform development]

⚠️ What Could Be Improved

• [e.g., Earlier start on deployment setup]
• [e.g., More thorough unit test coverage from the start]

---

📆 Course Info

Field	Detail
Course	COP 4331 – Processes of Object-Oriented Software
University	University of Central Florida
Semester	Spring 2022
Presentation	15 minutes — [Your Scheduled Date]

---

📜 License

This project was created for educational purposes as part of UCF COP 4331.