Skip to content

Latest commit

 

History

History
104 lines (76 loc) · 2.76 KB

README.md

File metadata and controls

104 lines (76 loc) · 2.76 KB

Schedulicious

The Menu Scheduler is a manual scheduling tool that enables managers to create and share weekly menus with staff. It simplifies communication by providing clear meal plans and accounting for dietary restrictions and allergies.

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • Yarn

Development

Install Dependencies

yarn install

Start Development Server

yarn dev

📖 Development Guide

Git Workflow

Branch Structure:

main ← release PR ← dev ← PR ← feature/bug branches

Steps:

  1. Create branch from dev
git checkout dev
git pull origin dev
git checkout -b feature/your-feature
  1. Push changes & create PR to dev
git push origin feature/your-feature
  1. After PR approval & merge:
    • Delete feature branch
    • Changes go to main via release PRs

Commit Messages

Format: [type]: message

Types:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation
  • style: Formatting
  • refactor: Code restructuring
  • test: Tests
  • chore: Maintenance

Examples:

feat: add calendar component
fix: resolve date picker bug
docs: update setup guide

Our Team

Original Documentation

Your project's readme is as important to success as your code. For this reason you should put as much care into its creation and maintenance as you would any other component of the application.

If you are unsure of what should go into the readme let this article, written by an experienced Chingu, be your starting point - Keys to a well written README.

And before we go there's "one more thing"! Once you decide what to include in your readme feel free to replace the text we've provided here.

Own it & Make it your Own!

Team Documents

You may find these helpful as you work together to organize your project.

Meeting Agenda templates (located in the /docs directory in this repo):

  • Meeting - Voyage Kickoff --> ./docs/meeting-voyage_kickoff.docx
  • Meeting - App Vision & Feature Planning --> ./docs/meeting-vision_and_feature_planning.docx
  • Meeting - Sprint Retrospective, Review, and Planning --> ./docs/meeting-sprint_retrospective_review_and_planning.docx
  • Meeting - Sprint Open Topic Session --> ./docs/meeting-sprint_open_topic_session.docx