Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs

name: Node.js CI

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
build:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [18.x, 20.x, 22.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- run: npm ci
- run: npm run build --if-present
- run: npm test
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
name: Node.js CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x, 20.x, 22.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- run: npm ci
- run: npm run build --if-present
- run: npm test
90 changes: 45 additions & 45 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
# Dependencies
node_modules/
/.pnp
.pnp.js

# Production
/dist
/build
*.tsbuildinfo

# Misc
.DS_Store
*.pem
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

# Environment variables
.env
.env.local
.env.*.local

# IDE
.vscode/
.idea/
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
.DS_Store

# OS
Thumbs.db
.DS_Store

# Testing
/coverage

# Temporary files
*.tmp
*.temp
# Dependencies
node_modules/
/.pnp
.pnp.js
# Production
/dist
/build
*.tsbuildinfo
# Misc
.DS_Store
*.pem
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
# Environment variables
.env
.env.local
.env.*.local
# IDE
.vscode/
.idea/
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
.DS_Store
# OS
Thumbs.db
.DS_Store
# Testing
/coverage
# Temporary files
*.tmp
*.temp
29 changes: 29 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Repository Guidelines

## Project Structure & Module Organization

This npm-workspaces monorepo contains a React application and its reusable utilities. Keep browser-independent logic in `packages/core/src/`; expose public APIs through `packages/core/src/index.ts`. Place its adjacent Vitest specs as `*.test.ts` (for example, `formatter.ts` and `formatter.test.ts`).

The user interface lives in `apps/web/src/`: `pages/` contains one tool screen per feature, `components/` contains shared UI, `App.tsx` defines routing, and `index.css` holds Tailwind/global styling. Build outputs (`packages/core/dist/` and `apps/web/dist/`) are generated—do not edit them manually. Use `scratch/` only for local experiments.

## Build, Test, and Development Commands

- `npm install` — install workspace dependencies (Node.js 18+).
- `npm run dev` — run the Vite web app at `http://localhost:5173`.
- `npm run build` — type-check and build every workspace.
- `npm test` — run workspace tests; currently this executes Vitest in `@dev-assistant/core` (the web app has no automated tests yet).
- `npm run test -w @dev-assistant/core` — run core tests alone while iterating on a utility.

## Coding Style & Naming Conventions

Use TypeScript with strict typing and ES modules. Follow the surrounding style: two-space indentation in core files and four-space indentation in React pages. Name utility modules in kebab-case (`text-analyzer.ts`), React pages in PascalCase (`TextAnalyzerPage.tsx`), exported functions in camelCase, and tests `*.test.ts`.

Prefer small, pure core functions that can run outside the browser. Keep UI-specific state and DOM access in `apps/web`. Reuse Tailwind utility classes and existing layout components rather than adding a separate styling system. No repository-wide formatter or linter script is configured; match nearby code and run the build before submitting.

## Testing Guidelines

Write Vitest coverage for each new or changed core behavior, including representative inputs, edge cases, and invalid input where applicable. Use `describe` to group a module's behavior and descriptive `test('...')` names. Test public functions directly; avoid tests that depend on browser globals unless they are explicitly part of the contract.

## Commit & Pull Request Guidelines

Recent history favors short, imperative messages, often with Conventional Commit prefixes, such as `feat: add BCrypt utility module`. Use `feat:`, `fix:`, `docs:`, or `chore:` when appropriate and keep each commit focused. Pull requests should explain the user-visible change, list validation performed (for example, `npm test` and `npm run build`), link relevant issues, and include screenshots for UI changes.
154 changes: 77 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,77 @@
# Dev Assistant 🚀

A comprehensive suite of developer tools designed to streamline your daily workflow. Built with performance, privacy, and ease of use in mind.

## ✨ Features

- **Code Formatter**: Quickly format your code using Prettier.
- **Diff Tool**: Compare two pieces of code or text to find differences.
- **JSON Parser**: Parse, validate, and format JSON data.
- **Unit Conversion**: Convert between various units (Length, Weight, Temp, etc.).
- **Image Converter**: Convert images between different formats directly in your browser.
- **Data Converter**: Convert data between formats like CSV, XML, and JSON.

## 🛠️ Tech Stack

- **Monorepo**: Managed with NPM Workspaces.
- **Frontend**: [React](https://reactjs.org/) + [Vite](https://vitejs.dev/) + [TypeScript](https://www.typescriptlang.org/).
- **Styling**: [Tailwind CSS](https://tailwindcss.com/).
- **Editor**: [Monaco Editor](https://microsoft.github.io/monaco-editor/) for a rich coding experience.
- **Utilities**:
- `diff-match-patch` for text comparisons.
- `prettier` for code formatting.
- `lucide-react` for beautiful icons.

## 📁 Project Structure

```text
.
├── apps/
│ └── web/ # The main React application (Vite)
├── packages/
│ └── core/ # Shared logic and utilities
├── package.json # Root workspace configuration
└── README.md # You are here
```

## 🚀 Getting Started

### Prerequisites

- [Node.js](https://nodejs.org/) (v18 or higher recommended)
- [NPM](https://www.npmjs.com/)

### Installation

1. Clone the repository:
```bash
git clone https://github.com/madcoderBubt/DevAsistant.git
cd DevAsistant
```

2. Install dependencies:
```bash
npm install
```

### Development

To start the development server for the web application:

```bash
npm run dev
```

The application will be available at `http://localhost:5173`.

### Building for Production

To build all packages and the web application:

```bash
npm run build
```

## 📄 License

This project is licensed under the MIT License - see the LICENSE file for details.
# Dev Assistant 🚀
A comprehensive suite of developer tools designed to streamline your daily workflow. Built with performance, privacy, and ease of use in mind.
## ✨ Features
- **Code Formatter**: Quickly format your code using Prettier.
- **Diff Tool**: Compare two pieces of code or text to find differences.
- **JSON Parser**: Parse, validate, and format JSON data.
- **Unit Conversion**: Convert between various units (Length, Weight, Temp, etc.).
- **Image Converter**: Convert images between different formats directly in your browser.
- **Data Converter**: Convert data between formats like CSV, XML, and JSON.
## 🛠️ Tech Stack
- **Monorepo**: Managed with NPM Workspaces.
- **Frontend**: [React](https://reactjs.org/) + [Vite](https://vitejs.dev/) + [TypeScript](https://www.typescriptlang.org/).
- **Styling**: [Tailwind CSS](https://tailwindcss.com/).
- **Editor**: [Monaco Editor](https://microsoft.github.io/monaco-editor/) for a rich coding experience.
- **Utilities**:
- `diff-match-patch` for text comparisons.
- `prettier` for code formatting.
- `lucide-react` for beautiful icons.
## 📁 Project Structure
```text
.
├── apps/
│ └── web/ # The main React application (Vite)
├── packages/
│ └── core/ # Shared logic and utilities
├── package.json # Root workspace configuration
└── README.md # You are here
```
## 🚀 Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/) (v18 or higher recommended)
- [NPM](https://www.npmjs.com/)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/madcoderBubt/DevAsistant.git
cd DevAsistant
```
2. Install dependencies:
```bash
npm install
```
### Development
To start the development server for the web application:
```bash
npm run dev
```
The application will be available at `http://localhost:5173`.
### Building for Production
To build all packages and the web application:
```bash
npm run build
```
## 📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
52 changes: 26 additions & 26 deletions apps/web/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Dev Assistant - Web Application

This is the frontend React application for the Dev Assistant project.

## Tech Stack

- **Framework**: React 18
- **Build Tool**: Vite
- **Styling**: Tailwind CSS
- **Code Editor**: Monaco Editor (@monaco-editor/react)
- **Icons**: Lucide React

## Scripts

- `npm run dev`: Starts the development server.
- `npm run build`: Builds the application for production.
- `npm run preview`: Previews the production build locally.

## Features Included

- Code Formatter
- Diff Tool
- JSON Parser
- Unit Conversion
- Image Converter
- Data Converter
# Dev Assistant - Web Application
This is the frontend React application for the Dev Assistant project.
## Tech Stack
- **Framework**: React 18
- **Build Tool**: Vite
- **Styling**: Tailwind CSS
- **Code Editor**: Monaco Editor (@monaco-editor/react)
- **Icons**: Lucide React
## Scripts
- `npm run dev`: Starts the development server.
- `npm run build`: Builds the application for production.
- `npm run preview`: Previews the production build locally.
## Features Included
- Code Formatter
- Diff Tool
- JSON Parser
- Unit Conversion
- Image Converter
- Data Converter
1 change: 0 additions & 1 deletion apps/web/dist/assets/index-19a9c237.css

This file was deleted.

Loading
Loading