221 lines
4.0 KiB
Markdown
221 lines
4.0 KiB
Markdown
# Quick Start Guide for Team Members
|
|
|
|
## 📋 For Akhib and Dundu
|
|
|
|
### Step 1: Accept Invitation ✉️
|
|
|
|
Check your email for GitHub invitation and click **Accept invitation**.
|
|
|
|
### Step 2: Clone Repository 📥
|
|
|
|
```bash
|
|
# Open terminal/command prompt and run:
|
|
git clone https://github.com/YOUR_USERNAME/frappe-frontend.git
|
|
cd frappe-frontend
|
|
```
|
|
|
|
### Step 3: Install Dependencies 📦
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
This will take a few minutes. Wait for it to complete.
|
|
|
|
### Step 4: Checkout Your Branch 🌿
|
|
|
|
**For Akhib:**
|
|
```bash
|
|
git checkout akhib
|
|
```
|
|
|
|
**For Dundu:**
|
|
```bash
|
|
git checkout dundu
|
|
```
|
|
|
|
### Step 5: Start Development 🚀
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open browser: http://localhost:3000
|
|
|
|
---
|
|
|
|
## 📝 Daily Workflow
|
|
|
|
### Morning (Start Work)
|
|
|
|
```bash
|
|
# Get latest changes
|
|
git pull origin akhib # or dundu
|
|
|
|
# Start dev server
|
|
npm run dev
|
|
```
|
|
|
|
### During Work (Save Changes)
|
|
|
|
```bash
|
|
# Check what changed
|
|
git status
|
|
|
|
# Add all changes
|
|
git add .
|
|
|
|
# Commit with message
|
|
git commit -m "Your description here"
|
|
|
|
# Push to remote
|
|
git push origin akhib # or dundu
|
|
```
|
|
|
|
### Evening (End of Day)
|
|
|
|
```bash
|
|
# Make sure everything is saved
|
|
git status
|
|
|
|
# Push if needed
|
|
git push origin akhib # or dundu
|
|
```
|
|
|
|
---
|
|
|
|
## 🆘 Common Issues
|
|
|
|
### Issue: "Permission denied"
|
|
|
|
**Solution:** Make sure you accepted the GitHub invitation.
|
|
|
|
### Issue: "npm install" fails
|
|
|
|
**Solution:**
|
|
```bash
|
|
# Delete node_modules
|
|
rm -rf node_modules
|
|
npm cache clean --force
|
|
npm install
|
|
```
|
|
|
|
### Issue: Branch doesn't exist
|
|
|
|
**Solution:**
|
|
```bash
|
|
git fetch origin
|
|
git checkout akhib # or dundu
|
|
```
|
|
|
|
### Issue: "Cannot push to remote"
|
|
|
|
**Solution:**
|
|
```bash
|
|
# Pull first, then push
|
|
git pull origin akhib
|
|
git push origin akhib
|
|
```
|
|
|
|
---
|
|
|
|
## 🎯 Important Commands
|
|
|
|
| Command | What it does |
|
|
|---------|--------------|
|
|
| `git status` | See what changed |
|
|
| `git add .` | Stage all changes |
|
|
| `git commit -m "msg"` | Save changes |
|
|
| `git push` | Upload to GitHub |
|
|
| `git pull` | Download from GitHub |
|
|
| `npm run dev` | Start dev server |
|
|
| `npm install` | Install packages |
|
|
|
|
---
|
|
|
|
## 📞 Need Help?
|
|
|
|
1. Check if dev server is running: http://localhost:3000
|
|
2. Check terminal for error messages
|
|
3. Try restarting: Stop server (Ctrl+C) and run `npm run dev` again
|
|
4. Contact team lead
|
|
|
|
---
|
|
|
|
## ✅ Checklist for First Day
|
|
|
|
- [ ] Accepted GitHub invitation
|
|
- [ ] Cloned repository
|
|
- [ ] Ran `npm install` successfully
|
|
- [ ] Switched to my branch (akhib or dundu)
|
|
- [ ] Started dev server (`npm run dev`)
|
|
- [ ] Saw application in browser
|
|
- [ ] Made test change
|
|
- [ ] Committed and pushed test change
|
|
- [ ] Saw my change on GitHub
|
|
|
|
---
|
|
|
|
## 🎨 Project Structure
|
|
|
|
```
|
|
frappe-frontend/
|
|
├── src/
|
|
│ ├── pages/ # All pages (Login, Dashboard, etc)
|
|
│ ├── components/ # Reusable components
|
|
│ ├── services/ # API calls
|
|
│ ├── hooks/ # Custom React hooks
|
|
│ └── contexts/ # React contexts (Theme, etc)
|
|
├── public/ # Static files
|
|
└── package.json # Project dependencies
|
|
```
|
|
|
|
---
|
|
|
|
## 🌟 Best Practices
|
|
|
|
1. **Commit often** - Don't wait until end of day
|
|
2. **Write clear messages** - "Fixed login bug" not "fixed stuff"
|
|
3. **Pull before push** - Always get latest changes first
|
|
4. **Test before commit** - Make sure it works
|
|
5. **Ask questions** - Better to ask than break things!
|
|
|
|
---
|
|
|
|
## 🔐 Git Config (One-time Setup)
|
|
|
|
```bash
|
|
# Set your name and email
|
|
git config --global user.name "Your Name"
|
|
git config --global user.email "your.email@example.com"
|
|
|
|
# Check settings
|
|
git config --list
|
|
```
|
|
|
|
---
|
|
|
|
## 💻 VS Code Extensions (Recommended)
|
|
|
|
- **ES7+ React/Redux/React-Native snippets**
|
|
- **GitLens** - Better Git integration
|
|
- **Prettier** - Code formatter
|
|
- **ESLint** - Code quality
|
|
- **Auto Rename Tag** - HTML/JSX helper
|
|
|
|
---
|
|
|
|
## 🎓 Learning Resources
|
|
|
|
- **React:** https://react.dev/learn
|
|
- **TypeScript:** https://www.typescriptlang.org/docs/
|
|
- **Git Basics:** https://git-scm.com/book/en/v2
|
|
- **Tailwind CSS:** https://tailwindcss.com/docs
|
|
|
|
---
|
|
|
|
**Remember:** Your branch (akhib/dundu) is YOUR workspace. Feel free to experiment!
|
|
|
|
Good luck! 🚀
|
|
|