https://github.com/rahulpeacock/react-readme-editor

https://github.com/rahulpeacock/react-readme-editor

Last synced: 26 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/rahulpeacock/react-readme-editor
• Owner: rahulpeacock
• Created: 2024-08-21T15:13:49.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-21T15:13:52.000Z (5 months ago)
• Last Synced: 2024-09-06T12:30:47.006Z (4 months ago)
• Language: TypeScript
• Size: 42 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## 🚀 React + Vite Sass kit

A simple, flexible and batteries-included starter template to kickstart your React projects with ease.

#### The Stack includes

- [Typescript](https://www.typescriptlang.org/) for type safe and scalable React app

- [React.js](https://react.dev/) as the framework for building frontend application

- [Tanstack Router](https://tanstack.com/router/latest) for type-safe and flexible client-side routing for React app

- [Tailwind CSS](https://tailwindcss.com/) for styling

- [Shadcn UI](https://ui.shadcn.com/) as the UI component library

- [Vite](https://vitejs.dev/guide/) for fast and optimized development and production build

- [Biome](https://biomejs.dev/) for formatting and linting

- [pnpm](https://pnpm.io/) as fast, efficient package-manager

#### Installation

1. Clone the repository ```git clone https://github.com/rahu1gg/react-vite-stack.git```

2. Navigate to the directory ```cd react-vite-stack```

3. Install dependencies ```pnpm install```

4. Starting the development server ```pnpm dev```

5. This will launch the app in development mode. Open [http://localhost:5143](http://localhost:5143) to view it in the browser.

> Make sure you have __Node.js__ and __pnpm__ installed in your machine

#### Project Structure

```

.

├── public

│   └── ...

├── src

│   ├── client

│   │   ├── providers

│   │   └── store

│   ├── components

│   │   ├── global

│   │   └── ui

│   ├── lib

│   │   └── utils

│   ├── routes

│   │   ├── __root.tsx

│   │   └── index.tsx

│   ├── styles

│   │   └── main.css

│   ├── main.tsx

│   └── ...

├── .gitignore

├── biome.json

├── components.json

├── package.json

├── tailwind.config.ts

├── tsconfig.json

├── vite.config.ts

└── ...

```

#### Support & Contribute

If you found this project helpful or enjoyed using it, please consider giving it a ⭐️ on GitHub! It helps others find the project and motivates us to keep improving.