-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,141 +1,28 @@ | ||
| <div align="center"> | ||
| <h1>ReVite</h1> | ||
| <h1>Icon Editor</h1> | ||
| </div> | ||
|
|
||
| <p align="center"> | ||
| <b>QuickStarter for React with Vite:</b> A streamlined template to kickstart your React projects with essential features built-in. Boost your development process with speed and efficiency. | ||
| Create a beautiful logo/icon for your website | ||
| </p> | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/vwh/revite/actions/workflows/format.yml"> | ||
| <img src="https://github.com/vwh/revite/actions/workflows/format.yml/badge.svg" alt="Check Format Badge"/> | ||
| <a href="https://github.com/vwh/icon-editor/actions/workflows/format.yml"> | ||
| <img src="https://github.com/vwh/icon-editor/actions/workflows/format.yml/badge.svg" alt="Check Format Badge"/> | ||
| </a> | ||
| <a href="https://github.com/vwh/revite/actions/workflows/lint.yml"> | ||
| <img src="https://github.com/vwh/revite/actions/workflows/lint.yml/badge.svg" alt="Lint Badge"/> | ||
| <a href="https://github.com/vwh/icon-editor/actions/workflows/lint.yml"> | ||
| <img src="https://github.com/vwh/icon-editor/actions/workflows/lint.yml/badge.svg" alt="Lint Badge"/> | ||
| </a> | ||
| </div> | ||
|
|
||
| <br> | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/vwh/revite" target="_blank"> | ||
| <img src="https://github.com/user-attachments/assets/9ab15a1e-aa04-4813-8b5c-ca75b72afa43" alt="Preview"> | ||
| <a href="https://github.com/vwh/icon-editor" target="_blank"> | ||
| <img src="https://github.com/user-attachments/assets/9277784d-0a34-4205-b1bf-af0b2fb5bb9c" alt="Preview"> | ||
| </a> | ||
| </div> | ||
|
|
||
| ## 🗃️ Project Structure | ||
|
|
||
| ```bash | ||
| 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 | ||
|
|
||
| Clone the repository and install dependencies: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/vwh/revite | ||
| cd revite | ||
|
|
||
| # Using Bun | ||
| bun install | ||
|
|
||
| # Or using npm | ||
| npm install | ||
| ``` | ||
|
|
||
| ### 💻 Development Server | ||
|
|
||
| Start the development server: | ||
|
|
||
| ```bash | ||
| # Using Bun | ||
| bun run dev | ||
|
|
||
| # Or using npm | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ### 🏗️ Build | ||
|
|
||
| Build the project for production: | ||
|
|
||
| ```bash | ||
| # Using Bun | ||
| bun run build | ||
|
|
||
| # Or using npm | ||
| npm run build | ||
| ``` | ||
|
|
||
| ### 👀 Preview | ||
|
|
||
| Preview the production build locally: | ||
|
|
||
| ```bash | ||
| # Using Bun | ||
| bun run preview | ||
|
|
||
| # Or using npm | ||
| npm run preview | ||
| ``` | ||
|
|
||
| ### 🧹 Linting | ||
|
|
||
| Lint the project files: | ||
|
|
||
| ```bash | ||
| # Using Bun | ||
| bun run lint | ||
|
|
||
| # Or using npm | ||
| npm run lint | ||
| ``` | ||
|
|
||
| ### 🎨 Formatting | ||
|
|
||
| Format the project files: | ||
|
|
||
| ```bash | ||
| # Using Bun | ||
| bun run format | ||
|
|
||
| # Or using npm | ||
| npm run format | ||
| ``` | ||
|
|
||
| Check the formatting: | ||
|
|
||
| ```bash | ||
| # Using Bun | ||
| bun run format:check | ||
|
|
||
| # Or using npm | ||
| npm run format:check | ||
| ``` | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| Contributions are welcome! Feel free to open a pull request with your improvements or fixes. |