FlowDev Web App

A modern web application for managing and visualizing development workflows.

Project Overview

FlowDev is a powerful web application designed to help development teams manage their workflows more efficiently. It provides a modern, intuitive interface for tracking tasks, managing sprints, and visualizing project progress.

Key Features

• Modern, responsive UI built with Next.js and Material-UI
• Real-time workflow visualization
• Task management and tracking
• Sprint planning and monitoring
• Team collaboration tools

Tech Stack

• Frontend Framework: Next.js 14
• UI Library: Material-UI (MUI)
• Styling: Emotion
• Type Safety: TypeScript
• Development Tools: ESLint, TypeScript

Getting Started

Prerequisites

• Node.js 18.x or later
• npm 9.x or later

Installation

1. Clone the repository:

   git clone https://github.com/shivankgoel/flowdev-web-app.git
   cd flowdev-web-app

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open http://localhost:3000 in your browser.

Local Development

The application uses the following development tools:

• ESLint: For code linting
• TypeScript: For type checking
• Next.js Fast Refresh: For instant feedback during development

Project Structure

flowdev-web-app/
├── app/                    # Next.js app directory
│   ├── components/        # Reusable UI components
│   ├── page.tsx          # Home page component
│   ├── layout.tsx        # Root layout component
│   └── theme/            # Theme configuration
├── public/               # Static assets
│   └── favicon.ico      # Site favicon
├── .gitignore           # Git ignore rules
├── next.config.js       # Next.js configuration
├── package.json         # Project dependencies
├── tsconfig.json        # TypeScript configuration
└── README.md           # Project documentation

Available Scripts

• npm run dev: Start the development server
• npm run build: Build the application for production
• npm run start: Start the production server
• npm run lint: Run ESLint to check code quality

Deployment

Vercel Deployment

1. Push your code to GitHub
2. Connect your repository to Vercel
3. Configure your deployment settings in the Vercel dashboard
4. Deploy!

Manual Deployment

1. Build the application:

   npm run build

2. Start the production server:

   npm run start

Contributing

1. Create a new branch for your feature:

   git checkout -b feature/your-feature-name

2. Make your changes and commit them:

   git add .
   git commit -m "feat: add your feature"

3. Push your changes and create a pull request:

   git push origin feature/your-feature-name

Branch Naming Convention

• feature/*: New features
• fix/*: Bug fixes
• docs/*: Documentation changes
• style/*: Code style changes
• refactor/*: Code refactoring
• test/*: Adding or modifying tests
• chore/*: Maintenance tasks

Pull Request Process

1. Update the README.md with details of changes if needed
2. Update the documentation if you're changing functionality
3. The PR will be merged once you have the sign-off of at least one other developer

License

This project is licensed under the MIT License - see the LICENSE file for details.