🚀 Development Workflow

For a step-by-step onboarding, see Getting Started

This guide explains how to set up your development environment and the recommended workflow for contributing to VibeCodex.

📋 Prerequisites

Before you begin, ensure you have the following installed:

Fork the Repository

Go to https://github.com/jalcantarab/v0-vibecodex and click the "Fork" button to create your own copy of the repository.

Clone Your Fork

git clone https://github.com/YOUR_USERNAME/v0-vibecodex.git
cd v0-vibecodex

Install Dependencies
```
npm install
# or
yarn install
```
Set Up Environment Variables

Copy the example environment file:
```
cp .env.example .env.local
```
Edit .env.local with any necessary values.
Start the Development Server
```
npm run dev
# or
yarn dev
```
The application will be available at http://localhost:3000.

We follow a feature branch workflow:

Create a Feature Branch
```
git checkout -b feature/your-feature-name
```
Use prefixes like:
- feature/ for new features
- fix/ for bug fixes
- docs/ for documentation changes
- refactor/ for code refactoring
Make Your Changes

Implement your changes, following the coding standards and patterns described in the Implementation Notes.
Commit Your Changes
```
git add .
git commit -m "feat: add your feature description"
```
We follow Conventional Commits for commit messages.

Push Your Changes

git push origin feature/your-feature-name

Create a Pull Request

Go to your fork on GitHub and click "New Pull Request" to submit your changes for review.

Before submitting your pull request, ensure:

To keep your fork in sync with the main repository:

Add the Upstream Remote

git remote add upstream https://github.com/jalcantarab/v0-vibecodex.git

Fetch and Merge Changes

git fetch upstream
git checkout main
git merge upstream/main
git push origin main

The project is automatically deployed to Vercel when changes are merged to the main branch.

For preview deployments:

If you need help with the development workflow:

Happy coding! 🎉