Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
vwh authored Jul 28, 2024
1 parent c02a9ef commit ecf2c5d
Showing 1 changed file with 67 additions and 3 deletions.
70 changes: 67 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<h1>ReVite</h1>
<div align="center">
<h1>ReVite</h1>
</div>

<div align="center">
Expand All @@ -16,9 +16,35 @@
</p>

<p align="center">
<img src="https://github.com/user-attachments/assets/3e726506-4873-41c6-9197-37bd9f938094" alt="Preview">
<img src="https://github.com/user-attachments/assets/25345150-7172-4349-8fb0-cd774cfa2a48" alt="Preview">
</p>

## Project Structure

```csharp
ReVite/
├── components.json # Configuration for Shadcn UI components
├── index.html # Main HTML file
├── package.json # Project metadata and dependencies
├── prettier.config.js # Prettier configuration
├── public/ # Public assets
│ └── images/ # Image assets
├── src/ # Source files
│ ├── App.tsx # Main app component
│ ├── components/ # React components
│ │ └── ui/ # UI components
│ ├── hooks/ # Custom hooks
│ ├── index.css # Main CSS file
│ ├── lib/ # Utility functions
│ ├── main.tsx # Main entry point
│ └── vite-env.d.ts # TypeScript Vite environment definitions
├── tailwind.config.js # Tailwind CSS configuration
├── tsconfig.app.json # TypeScript app configuration
├── tsconfig.json # TypeScript base configuration
├── tsconfig.node.json # TypeScript Node configuration
└── vite.config.ts # Vite configuration
```

## Getting Started

### Installation
Expand All @@ -39,6 +65,44 @@ Start the development server:
npm run dev
```

### Build

Build the project for production:

```bash
npm run build
```

### Preview

Preview the production build locally:

```bash
npm run preview
```

### Linting

Lint the project files:

```bash
npm run lint
```

### Formatting

Format the project files:

```bash
npm run format
```

Check the formatting:

```bash
npm run format:check
```

## Contributing

Contributions are welcome! Fork the repository, create your feature branch, commit your changes, and submit a pull request.

0 comments on commit ecf2c5d

Please sign in to comment.