Codexa

Planit: Event Planner Project Documentation

Overview

Planit is an Event Planning platform that allows users to create and plan events, invite guests, and connect with vendors. The system will be mobile-friendly, support OAuth authentication, and provide a user-friendly interface for event organization and planning. Visit our Github repository here!!. PlanIt, Plan events that people remember because perfect events don’t happen by accident!.

Documentation Folder Structure

The docs folder is organized as follows:

• development/: Technical documentation, methodologies, backend structure, and mockups.
• meetings/: Notes and summaries from project meetings and sprints.
• planning/: Sprint planning documents, team roles, user stories, and communication plans.
• assets/: Images, videos, and mockups used throughout the documentation.

This structure helps keep all project documentation organized and easy to navigate.

Project Goals

• Enable event creation and planning
• Guest invitations (manual, RSVP, CSV import) and track invitations
• Adding Vendors to events and get recommendations based on event location
• Get vendor qoutes and compare qoutes among vendors
• Secure user authentication via OAuth
• Responsive design for mobile and desktop
• Easy-to-use dashboard for managing events

Tech Stack

Tech Stack explained

• Frontend: React 19, Vite, Tailwind CSS
• Backend: Node.js, Express.js, MongoDB
• Authentication: OAuth
• Deployment: Microsoft Azure
• Project Management: Trello
• Documentation: Markdown + GitHub Pages
• Testing: Frontend, Backend, Manual Testing, User testing
• Third Party code: Auth0, OpenWeather API
• Our Backend API Documentation

Methodologies

We follow the Agile Scrum methodology:

• Standups: Tuesdays, Thursdays, Sundays
• Sprint Retrospectives: After every sprint
• Roles are rotated every sprint

We follow the Github Flow methodology:

• main (or master) branch always deployable
• Create short-lived feature branches
• Open a Pull Request when work is ready
• Get peer review + approval
• Merge to main
• Deploy from main

Project methodologies explained

Communication Tools

• WhatsApp
• Discord
• Trello Board (link)
• GitHub Issues and Pull Requests
• Microsoft teams

Team communication plan

Implementation

• Sprint one
  • Sprint 1 brief
  • Sprint 1 User Stories
  • Team Roles
  • Mockups
  • First Meeting Notes
  • Scrum 01
  • Scrum 02
  • Scrum 03
  • Scrum 04
• Sprint two
  • Sprint 2 brief
  • Sprint Development Plan
  • Scrum 01
  • Scrum 02
  • Scrum 03
  • Scrum 04
  • Scrum 05

---