From 705b5087f4e9df9a9c8805325773c1aacea73285 Mon Sep 17 00:00:00 2001 From: jarno Date: Sat, 2 Aug 2025 10:56:55 +0300 Subject: [PATCH] feat: removed generated readme --- .cursor/rules/git-feature-branch.mdc | 111 ++++++++++++++ frontend/README.md | 222 --------------------------- 2 files changed, 111 insertions(+), 222 deletions(-) create mode 100644 .cursor/rules/git-feature-branch.mdc delete mode 100644 frontend/README.md diff --git a/.cursor/rules/git-feature-branch.mdc b/.cursor/rules/git-feature-branch.mdc new file mode 100644 index 0000000..8d71391 --- /dev/null +++ b/.cursor/rules/git-feature-branch.mdc @@ -0,0 +1,111 @@ +--- +alwaysApply: true +--- + +# Git Feature Branch Workflow + +## Always Work in Feature Branches + +**CRITICAL**: Never work directly on `main` or `master` branches. Always create and use feature branches for all development work. + +## Feature Branch Naming Convention + +Use descriptive, kebab-case names for feature branches: +- `feature/user-authentication` +- `feature/dashboard-redesign` +- `bugfix/login-validation` +- `hotfix/security-patch` +- `refactor/api-endpoints` + +## Workflow Steps + +### 1. Before Starting Work +```bash +# Ensure you're on main and it's up to date +git checkout main +git pull origin main + +# Create and switch to a new feature branch +git checkout -b feature/your-feature-name +``` + +### 2. During Development +- Make frequent, small commits with descriptive messages +- Use conventional commit format: `type(scope): description` +- Examples: + - `feat(auth): add login form validation` + - `fix(ui): resolve button alignment issue` + - `refactor(api): simplify user data fetching` + +### 3. Before Pushing +```bash +# Ensure your branch is up to date with main +git fetch origin +git rebase origin/main + +# Push your feature branch +git push origin feature/your-feature-name +``` + +### 4. Code Review Process +- Create a Pull Request (PR) from your feature branch to main +- Request reviews from team members +- Address feedback and push updates to the same branch +- Only merge after approval + +### 5. After Merge +```bash +# Switch back to main and update +git checkout main +git pull origin main + +# Delete the feature branch (local and remote) +git branch -d feature/your-feature-name +git push origin --delete feature/your-feature-name +``` + +## Best Practices + +### Commit Messages +- Use present tense ("add feature" not "added feature") +- Be specific and descriptive +- Reference issue numbers when applicable: `feat(auth): add OAuth login #123` + +### Branch Management +- Keep feature branches short-lived (1-3 days ideally) +- One feature per branch +- Don't mix different types of changes in one branch + +### Before Creating PRs +- Ensure all tests pass +- Update documentation if needed +- Self-review your changes +- Ensure code follows project conventions + +## Emergency Hotfixes + +For critical production issues: +```bash +# Create hotfix branch from main +git checkout main +git checkout -b hotfix/critical-issue-name + +# Make minimal necessary changes +# Test thoroughly +# Create PR for immediate review +``` + +## Integration with CI/CD + +- Feature branches should trigger CI/CD pipelines +- All tests must pass before merging +- Code coverage should not decrease +- Security scans should pass + +## Remember + +- **Never commit directly to main/master** +- **Always create a feature branch for new work** +- **Keep branches focused and small** +- **Use descriptive branch and commit names** +- **Review your own code before requesting reviews** diff --git a/frontend/README.md b/frontend/README.md deleted file mode 100644 index 23f9fb4..0000000 --- a/frontend/README.md +++ /dev/null @@ -1,222 +0,0 @@ -# Vibing - React + Vite Application - -A modern React application built with Vite, featuring beautiful components and a responsive design that adapts to any device. - -## 🚀 Features - -- **Fast Development**: Built with Vite for lightning-fast development and hot module replacement -- **Modern React**: Using React 19 with modern hooks and patterns -- **Responsive Design**: Fully responsive design that looks great on all devices -- **Component Library**: Reusable components with consistent styling -- **Custom Hooks**: Useful custom hooks for common functionality -- **API Utilities**: Built-in API utilities with error handling -- **Modern Styling**: Beautiful gradients and modern CSS design - -## 📦 Project Structure - -``` -src/ -├── components/ # Reusable UI components -│ ├── Header.jsx # Navigation header -│ ├── Footer.jsx # Site footer -│ ├── Button.jsx # Reusable button component -│ ├── Card.jsx # Card component for content -│ └── index.js # Component exports -├── hooks/ # Custom React hooks -│ └── useLocalStorage.js -├── pages/ # Page components -│ ├── Home.jsx # Home page -│ └── Home.css -├── utils/ # Utility functions -│ └── api.js # API utilities -├── styles/ # Global styles (future use) -├── assets/ # Static assets -├── App.jsx # Main app component -├── App.css # Global styles -├── main.jsx # App entry point -└── index.css # Base styles -``` - -## 🛠️ Getting Started - -### Prerequisites - -- Node.js (version 16 or higher) -- npm or yarn - -### Installation - -1. Clone the repository: -```bash -git clone -cd vibing -``` - -2. Install dependencies: -```bash -npm install -``` - -3. Start the development server: -```bash -npm run dev -``` - -4. Open your browser and navigate to `http://localhost:5173` - -## 📜 Available Scripts - -- `npm run dev` - Start development server -- `npm run build` - Build for production -- `npm run preview` - Preview production build -- `npm run lint` - Run ESLint - -## 🎨 Components - -### Button Component - -```jsx -import { Button } from './components'; - -// Different variants - - - - - -// Different sizes - - - -``` - -### Card Component - -```jsx -import { Card } from './components'; - - -

Card content goes here...

- -``` - -### Header & Footer - -```jsx -import { Header, Footer } from './components'; - -// Header with navigation -
- -// Footer with links and social media -