Skip to content

Commit b5059d6

Browse files
chloezhoudevchloezhoudev
committed
chore: sync templates from main to dev
1 parent 01b06b8 commit b5059d6

File tree

17 files changed

+2726
-56
lines changed

17 files changed

+2726
-56
lines changed

‎.eslintrc.json

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"env": {
3+
"browser": true,
4+
"es2021": true,
5+
"node": true
6+
},
7+
"extends": [
8+
"eslint:recommended",
9+
"plugin:react/recommended",
10+
"plugin:react-hooks/recommended",
11+
"plugin:prettier/recommended"
12+
],
13+
"parserOptions": {
14+
"ecmaVersion": "latest",
15+
"sourceType": "module",
16+
"ecmaFeatures": {
17+
"jsx": true
18+
}
19+
},
20+
"plugins": ["react", "prettier"],
21+
"rules": {
22+
"react/react-in-jsx-scope": "off",
23+
"react/prop-types": "off",
24+
"prettier/prettier": "error",
25+
"no-unused-vars": "warn",
26+
27+
// General JavaScript
28+
"no-console": "warn",
29+
"no-debugger": "warn",
30+
"no-duplicate-imports": "error",
31+
32+
// React Hooks rules
33+
"react-hooks/rules-of-hooks": "error",
34+
"react-hooks/exhaustive-deps": "warn",
35+
36+
// React specific
37+
"react/jsx-no-target-blank": "error",
38+
"react/jsx-pascal-case": "error",
39+
"react/no-array-index-key": "warn",
40+
"react/self-closing-comp": "error"
41+
},
42+
"settings": {
43+
"react": {
44+
"version": "detect"
45+
}
46+
}
47+
}

‎.github/ISSUE_TEMPLATE/epic-template.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
---
2-
name: Epic
3-
about: Create an epic to group related features
4-
title: 'Epic: '
2+
name: Epic template
3+
about: An epic represents functionality that will span multiple sprints
4+
title: ''
55
labels: epic
66
assignees: ''
7-
---
87

9-
## Feature Description
10-
[Describe what this feature is intended to accomplish and why it's important]
8+
---
119

12-
## Business Value
13-
[Explain the value this epic brings to users/business]
10+
**__Feature Description__**
11+
Describe what the feature is intended to accomplish & why it's important
1412

15-
## Major User Stories/tasks
16-
- [ ] Story/Task 1
17-
- [ ] Story/Task 2
13+
**__Major User Stories/tasks__**
14+
- [ ] User Story or Task #1
15+
- [ ] User Story or Task #2
16+
- [ ] Additional User Stories or Tasks as necessary
1817

19-
## Acceptance Criteria
20-
- [ ] Criteria 1
21-
- [ ] Criteria 2
18+
**__Additional Considerations__**
19+
Include anything else that may be helpful. For example, links to external resources.

‎.github/ISSUE_TEMPLATE/task-template.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
---
2-
name: Task
3-
about: Create a technical task
4-
title: '[Task] '
2+
name: Task template
3+
about: Tasks are small units of work that can be completed in a single sprint
4+
title: ''
55
labels: task
66
assignees: ''
7-
---
87

9-
## Task Description
10-
[Clear description of the technical task]
8+
---
119

12-
## Technical Requirements
13-
- [ ] Requirement 1
14-
- [ ] Requirement 2
10+
**__Task Description__**
11+
Describe the task to be completed.
1512

16-
## Related User Story
17-
Part of User Story #[story-number]
13+
**__Technical Considerations__**
14+
Include any technical considerations including architecture (e.g. API), required libraries, etc.
1815

16+
**__Additional Considerations__**
17+
Any supplemental information including unresolved questions, links to external resources, screenshots, etc.

‎.github/ISSUE_TEMPLATE/user-story-template.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
name: User Story
3-
about: Create a user story
4-
title: '[Story] '
5-
labels: user-story
2+
name: User Story template
3+
about: User Stories are features supporting user requirements that can be completed
4+
in a single sprint
5+
title: ''
6+
labels: user_story
67
assignees: ''
7-
---
88

9-
## User Story Description
10-
As a [type of user]
11-
I want to [perform some action]
12-
So that [achieve some goal/benefit]
9+
---
1310

14-
## Acceptance Criteria
15-
- [ ] Criteria 1
16-
- [ ] Criteria 2
11+
**__User Story Description__**
12+
As a [role]
13+
I want to [action to be performed]
14+
So I can [result to be achieved]
1715

18-
## Technical Notes
19-
[Any technical considerations or notes]
16+
**__Steps to Follow (optional)__**
17+
- [ ] Step #1
18+
- [ ] Step #2
19+
- [ ] Additional steps as necessary
2020

21-
## Related Epic
22-
Related to Epic #[epic-number]
21+
**__Additional Considerations__**
22+
Any supplemental information including unresolved questions, links to external resources, screenshots, etc.

‎.github/workflows/ci.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI
2+
3+
# When should this run?
4+
on:
5+
push:
6+
branches: [ dev ] # Runs on pushes to dev
7+
pull_request:
8+
branches: [ main, dev ] # Runs on PRs to main or dev
9+
10+
# What jobs should run?
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest # Use Ubuntu as environment
14+
15+
steps:
16+
# Step 1: Get the code
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
20+
# Step 2: Setup Node.js
21+
- name: Setup Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: '18'
25+
cache: 'yarn'
26+
27+
# Step 3: Install dependencies
28+
- name: Install dependencies
29+
run: yarn install --frozen-lockfile
30+
31+
# Step 4: Run lint
32+
- name: Lint
33+
run: yarn lint
34+
35+
# Step 5: Try to build
36+
- name: Build
37+
run: yarn build

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
dist
3+
dist-ssr
4+
*.local
5+
.DS_Store
6+
.eslintcache

‎.prettierignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Dependencies
2+
node_modules
3+
4+
# Build output
5+
dist
6+
7+
# Everything except src
8+
/*
9+
!/src

‎.prettierrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"semi": true,
3+
"tabWidth": 4,
4+
"printWidth": 100,
5+
"singleQuote": true,
6+
"trailingComma": "es5",
7+
"jsxSingleQuote": false,
8+
"bracketSpacing": true,
9+
"endOfLine": "auto"
10+
}

‎.vscode/settings.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"editor.defaultFormatter": "esbenp.prettier-vscode",
3+
"editor.formatOnSave": true,
4+
"editor.codeActionsOnSave": {
5+
"source.fixAll.eslint": "explicit"
6+
},
7+
"eslint.validate": ["javascript", "javascriptreact"],
8+
"eslint.enable": true,
9+
"eslint.run": "onType"
10+
}

‎README.md

Lines changed: 77 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,80 @@
1-
# voyage-tasks
1+
# Schedulicious
2+
3+
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.
4+
5+
## 🚀 Getting Started
6+
7+
### Prerequisites
8+
- Node.js (v18 or higher)
9+
- Yarn
10+
11+
### Development
12+
13+
#### Install Dependencies
14+
```bash
15+
yarn install
16+
```
17+
18+
#### Start Development Server
19+
```bash
20+
yarn dev
21+
```
22+
## 📖 Development Guide
23+
24+
### Git Workflow
25+
26+
**Branch Structure:**
27+
```
28+
main ← release PR ← dev ← PR ← feature/bug branches
29+
```
30+
31+
**Steps:**
32+
1. Create branch from `dev`
33+
```bash
34+
git checkout dev
35+
git pull origin dev
36+
git checkout -b feature/your-feature
37+
```
38+
39+
2. Push changes & create PR to `dev`
40+
```bash
41+
git push origin feature/your-feature
42+
```
43+
44+
3. After PR approval & merge:
45+
- Delete feature branch
46+
- Changes go to `main` via release PRs
47+
48+
### Commit Messages
49+
Format: `[type]: message`
50+
51+
Types:
52+
- `feat`: New features
53+
- `fix`: Bug fixes
54+
- `docs`: Documentation
55+
- `style`: Formatting
56+
- `refactor`: Code restructuring
57+
- `test`: Tests
58+
- `chore`: Maintenance
59+
60+
Examples:
61+
```bash
62+
feat: add calendar component
63+
fix: resolve date picker bug
64+
docs: update setup guide
65+
```
66+
67+
## Our Team
68+
69+
- Chloe Zhou #1: [GitHub](https://github.com/xyzhou-projects) / [LinkedIn](https://www.linkedin.com/in/xyzhou-developer)
70+
- Nurul Mukhlisa #2: [GitHub](https://github.com/numulaa) / [LinkedIn](https://www.linkedin.com/in/nurul-mukhlisa/)
71+
72+
...
73+
74+
- Teammate name #n: [GitHub](https://github.com/ghaccountname) / [LinkedIn](https://linkedin.com/in/liaccountname)
75+
76+
---
77+
## Original Documentation
278

379
Your project's `readme` is as important to success as your code. For
480
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):
26102
- Meeting - App Vision & Feature Planning --> ./docs/meeting-vision_and_feature_planning.docx
27103
- Meeting - Sprint Retrospective, Review, and Planning --> ./docs/meeting-sprint_retrospective_review_and_planning.docx
28104
- Meeting - Sprint Open Topic Session --> ./docs/meeting-sprint_open_topic_session.docx
29-
30-
## Our Team
31-
32-
Everyone on your team should add their name along with a link to their GitHub
33-
& optionally their LinkedIn profiles below. Do this in Sprint #1 to validate
34-
your repo access and to practice PR'ing with your team _before_ you start
35-
coding!
36-
37-
- Chloe Zhou #1: [GitHub](https://github.com/xyzhou-projects) / [LinkedIn](https://www.linkedin.com/in/xyzhou-developer)
38-
- Nurul Mukhlisa #2: [GitHub](https://github.com/numulaa) / [LinkedIn](https://www.linkedin.com/in/nurul-mukhlisa/)
39-
40-
...
41-
42-
- Teammate name #n: [GitHub](https://github.com/ghaccountname) / [LinkedIn](https://linkedin.com/in/liaccountname)

‎index.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>Vite + React</title>
7+
</head>
8+
<body>
9+
<div id="root"></div>
10+
<script type="module" src="/src/main.jsx"></script>
11+
</body>
12+
</html>

‎package.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"name": "schedulicious",
3+
"version": "1.0.0",
4+
"main": "index.js",
5+
"repository": "git@github.com:chingu-voyages/V53-tier2-team-20.git",
6+
"license": "MIT",
7+
"scripts": {
8+
"dev": "vite",
9+
"build": "vite build",
10+
"preview": "vite preview",
11+
"lint": "eslint \"src/**/*.{js,jsx}\" --fix",
12+
"format": "prettier --write \"src/**/*\""
13+
},
14+
"dependencies": {
15+
"react": "^19.0.0",
16+
"react-dom": "^19.0.0"
17+
},
18+
"devDependencies": {
19+
"@vitejs/plugin-react": "^4.3.4",
20+
"eslint": "^8.56.0",
21+
"eslint-config-prettier": "^9.1.0",
22+
"eslint-plugin-prettier": "^5.2.1",
23+
"eslint-plugin-react": "^7.37.3",
24+
"eslint-plugin-react-hooks": "^5.1.0",
25+
"prettier": "^3.4.2",
26+
"vite": "^6.0.7"
27+
}
28+
}

‎src/App.jsx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import React from 'react';
2+
3+
function App() {
4+
return (
5+
<div>
6+
<h1>Hello Vite + React!</h1>
7+
</div>
8+
);
9+
}
10+
11+
export default App;

‎src/main.jsx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import React from 'react';
2+
import ReactDOM from 'react-dom/client';
3+
import App from './App';
4+
import './styles/index.css';
5+
6+
ReactDOM.createRoot(document.getElementById('root')).render(
7+
<React.StrictMode>
8+
<App />
9+
</React.StrictMode>
10+
);

0 commit comments

Comments
 (0)