jarno/vibing
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat: removed generated readme

Browse Source
This commit is contained in:
jarno
2025-08-02 10:56:55 +03:00
parent 99032bf03c
commit 705b5087f4
2 changed files with 111 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
.cursor/rules/git-feature-branch.mdc Normal file
View File

@@ -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**

222
frontend/README.md
View File

@@ -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 <repository-url>
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
<Button variant="primary">Primary Button</Button>
<Button variant="secondary">Secondary Button</Button>
<Button variant="outline">Outline Button</Button>
<Button variant="ghost">Ghost Button</Button>
// Different sizes
<Button size="small">Small</Button>
<Button size="medium">Medium</Button>
<Button size="large">Large</Button>
```
### Card Component
```jsx
import { Card } from './components';
<Card
title="Card Title"
subtitle="Card subtitle"
image="https://example.com/image.jpg"
>
<p>Card content goes here...</p>
</Card>
```
### Header & Footer
```jsx
import { Header, Footer } from './components';
// Header with navigation
<Header />
// Footer with links and social media
<Footer />
```
## 🔧 Custom Hooks
### useLocalStorage
```jsx
import useLocalStorage from './hooks/useLocalStorage';
const [value, setValue] = useLocalStorage('key', initialValue);
```
## 🌐 API Utilities
```jsx
import { api } from './utils/api';
// GET request
const data = await api.get('/users');
// POST request
const newUser = await api.post('/users', { name: 'John', email: 'john@example.com' });
// PUT request
const updatedUser = await api.put('/users/1', { name: 'Jane' });
// DELETE request
await api.delete('/users/1');
```
## 🎯 Environment Variables
Create a `.env` file in the root directory:
```env
VITE_API_BASE_URL=http://localhost:3000/api
```
## 📱 Responsive Design
The application is fully responsive and includes:
- Mobile-first design approach
- Flexible grid layouts
- Responsive typography
- Touch-friendly interactions
- Optimized for all screen sizes
## 🎨 Styling
The project uses:
- CSS modules for component-specific styles
- CSS custom properties for theming
- Flexbox and Grid for layouts
- Modern CSS features like gradients and animations
- Responsive design patterns
## 🚀 Deployment
### Build for Production
```bash
npm run build
```
The build output will be in the `dist` directory, ready for deployment to any static hosting service.
### Deploy to Vercel
1. Install Vercel CLI:
```bash
npm i -g vercel
```
2. Deploy:
```bash
vercel
```
### Deploy to Netlify
1. Build the project:
```bash
npm run build
```
2. Upload the `dist` folder to Netlify
## 🤝 Contributing
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- [Vite](https://vitejs.dev/) for the fast build tool
- [React](https://reactjs.org/) for the UI library
- [Unsplash](https://unsplash.com/) for the beautiful images