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
77 changes: 77 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +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.
26 changes: 26 additions & 0 deletions apps/web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +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
2 changes: 2 additions & 0 deletions apps/web/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import DiffPage from './pages/DiffPage';
import JSONParserPage from './pages/JSONParserPage';
import UnitConversionPage from './pages/UnitConversionPage';
import ImageConverterPage from './pages/ImageConverterPage';
import DataConverterPage from './pages/DataConverterPage';

function App() {
return (
Expand All @@ -17,6 +18,7 @@ function App() {
<Route path="parser" element={<JSONParserPage />} />
<Route path="unit-conversion" element={<UnitConversionPage />} />
<Route path="image-converter" element={<ImageConverterPage />} />
<Route path="data-converter" element={<DataConverterPage />} />
</Route>
</Routes>
</BrowserRouter>
Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/components/Layout.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Link, Outlet, useLocation } from 'react-router-dom';
import { FileJson, ArrowLeftRight, Code2, Braces, Ruler, Image } from 'lucide-react';
import { FileJson, ArrowLeftRight, Code2, Braces, Ruler, Image, Database } from 'lucide-react';

export default function Layout() {
const location = useLocation();
Expand All @@ -10,6 +10,7 @@ export default function Layout() {
{ path: '/diff', label: 'Diff Viewer', icon: ArrowLeftRight },
{ path: '/unit-conversion', label: 'Unit Converter', icon: Ruler },
{ path: '/image-converter', label: 'Image Converter', icon: Image },
{ path: '/data-converter', label: 'Data Converter', icon: Database },
];

return (
Expand Down
Loading
Loading