@ -1,55 +0,0 @@
# React TS Boilerplate

## Technology Stack

- [Vite](https://vitejs.dev): Efficient build tool for modern browsers.
- [React](https://reactjs.org): JavaScript library for building user interfaces.
- [TypeScript](https://www.typescriptlang.org): Superset of JavaScript with static type-checking.
- [Ramda](https://ramdajs.com/): Functional programming library for JavaScript.
- [Zustand](https://zustand-demo.pmnd.rs/): Small, fast and scaleable bearbones state-management solution.

## Quick Start

Install project dependencies

```
pnpm install
```

Launch the app, it will become available at [http://localhost:3000](http://localhost:3000/)

```
pnpm dev
```

## Project Standards

- xxx
- xxx
- xxx

## Directory Structure

`├──`[`.vscode`](.vscode) — VSCode settings including code snippets, recommended extensions etc<br>
`├──`[`public`](./public) — Static assets such as robots.txt, index.html etc<br>
`├──`[`src/assets`](./src/assets) — Static assets<br>
`├──`[`src/components`](./src/components) — React public components<br>
`├──`[`src/hooks`](./src/hooks) — React public hooks<br>
`├──`[`src/stores`](./src/stores) — Status Management<br>
`├──`[`src/pages`](./src/pages) — Application and page (screen) components<br>
`├──`[`src/routes`](./src/routes) — Application routes components<br>
`├──`[`src/theme`](./src/services) — External connection service<br>
`├──`[`src/utils`](./src/utils) — Utility functions<br>

## Recommended VSCode Extensions

- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss): IntelliSense for Tailwind CSS.
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode&ssr=false#overview): Code formatting tool.
- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig): Editor configuration consistency.

## Coding Conventions

- Check [here](https://github.com/sj-distributor/react-coding-conventions).