diff --git a/README.md b/README.md index 1aed51e..d00498d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,80 @@ -# voyage-tasks +# 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 +```bash +yarn install +``` + +#### Start Development Server +```bash +yarn dev +``` +## 📖 Development Guide + +### Git Workflow + +**Branch Structure:** +``` +main ← release PR ← dev ← PR ← feature/bug branches +``` + +**Steps:** +1. Create branch from `dev` +```bash +git checkout dev +git pull origin dev +git checkout -b feature/your-feature +``` + +2. Push changes & create PR to `dev` +```bash +git push origin feature/your-feature +``` + +3. 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: +```bash +feat: add calendar component +fix: resolve date picker bug +docs: update setup guide +``` + +## Our Team + +- Chloe Zhou #1: [GitHub](https://github.com/xyzhou-projects) / [LinkedIn](https://www.linkedin.com/in/xyzhou-developer) +- Nurul Mukhlisa #2: [GitHub](https://github.com/numulaa) / [LinkedIn](https://www.linkedin.com/in/nurul-mukhlisa/) + + ... + +- Teammate name #n: [GitHub](https://github.com/ghaccountname) / [LinkedIn](https://linkedin.com/in/liaccountname) + +--- +## 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 @@ -26,17 +102,3 @@ Meeting Agenda templates (located in the `/docs` directory in this repo): - 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 - -## Our Team - -Everyone on your team should add their name along with a link to their GitHub -& optionally their LinkedIn profiles below. Do this in Sprint #1 to validate -your repo access and to practice PR'ing with your team _before_ you start -coding! - -- Chloe Zhou #1: [GitHub](https://github.com/xyzhou-projects) / [LinkedIn](https://www.linkedin.com/in/xyzhou-developer) -- Nurul Mukhlisa #2: [GitHub](https://github.com/numulaa) / [LinkedIn](https://www.linkedin.com/in/nurul-mukhlisa/) - - ... - -- Teammate name #n: [GitHub](https://github.com/ghaccountname) / [LinkedIn](https://linkedin.com/in/liaccountname) diff --git a/package.json b/package.json index f0b0d3e..0c9a15a 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "V53-tier2-team-20", + "name": "schedulicious", "version": "1.0.0", "main": "index.js", "repository": "git@github.com:chingu-voyages/V53-tier2-team-20.git",