Skip to content

Commit

Permalink
chore: Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
ozhanefemeral committed Jul 24, 2024
1 parent 2e274dd commit 4130767
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ console.log(generatedCode);
To set up the project for development:

1. Clone the repository: `git clone https://github.com/ozhanefemeral/ts-generator`
2. Install dependencies: `pnpm install`
3. Build all packages: `pnpm build`
4. Start the development server: `pnpm dev`
2. Install dependencies: `bun install`
3. Build all packages: `bun build`
4. Start the development server: `bun dev`
5. Open the Next.js app in your browser at `http://localhost:3000`

## Contributing
Expand Down
11 changes: 9 additions & 2 deletions apps/next/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,43 @@
# VisualTS

Develop TypeScript / React apps with drag & drop!

![code-generator](https://github.com/ozhanefemeral/visual-ts/assets/22786810/2939341e-8a37-428a-80aa-a76c35c3a1b5)

## Overview

The VisualTS tool allows you to visualize the structure and contents of TypeScript files and React components. It aims to provide a user-friendly interface for developers to explore and understand the codebase they're working with.

![image](https://github.com/ozhanefemeral/visual-ts/assets/22786810/d288b080-ce05-405e-b9c1-2d112dc5ba04)

## Key Features

- **Drag-and-drop Code Generation**: By simply dragging and dropping funcitons declared in your codebase; you can build custom functions.
- **Parsing TypeScript Files**: The tool can parse TypeScript files and extract information about the functions, variables and relationships.
- **Visualizing TypeScript Modules**: The parsed information is presented in a visual format, making it easier to understand the structure and dependencies of TypeScript modules.
- **Visualizing React Components**: The tool can also parse and visualize React components, showing the component hierarchy and the props/state relationships.

## Getting Started

1. Clone the repository: `git clone https://github.com/ozhanefemeral/visual-ts`
2. Install dependencies: `bun install`

3. Start the development server: `bun dev`
4. Open the application in your browser at `http://localhost:3000`

p.s. You can use npm, yarn and pnpm too
p.s. You can use npm, yarn and bun too

## Usage

1. Create a file, with `.ts` or `.tsx` extension. It supports only these file types _for now_.
2. In `app/page.tsx` render it using `<FileParser />` component. There is an example left out in app/page.tsx.

## Roadmap

1. Make utility functions such as colorizing and parsing functions a package; independent from this repo.
2. Fixing colorization. Right now `Promise<User[]>`, `User[]`, and `User` returns different colors. They could be shades of eachother.
3. Add drag & drop functionality to create new modules or edit existing ones.

## Contributing
Any contribution is welcomed! Feel free to contact me or open an issue.

Any contribution is welcomed! Feel free to contact me or open an issue.
4 changes: 2 additions & 2 deletions packages/ts-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@

## Installation

Install the package using pnpm:
Install the package using bun:

```bash
pnpm add @ozhanefe/ts-codegenerator
bun add @ozhanefe/ts-codegenerator
```

Note: This package requires TypeScript as a peer dependency. Make sure you have TypeScript installed in your project.
Expand Down

0 comments on commit 4130767

Please sign in to comment.