template-react-app/README.md

53 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# DaisyUI-React-Starter
[![Build Status](https://jenkins.bigoscloud.com/job/LuPa2/lastBuild/badge/icon)](https://jenkins.bigoscloud.com/job/LuPa2/lastBuild/)
Toolstack for my UI projects. I try to use `bun`.
> It was challenging stuff to configure, but now it works like a charm... I think.
<img style="width: 256px; height: 256px; margin-left: 50%; translate: -50%;" src="lupa2Logo.webp"/>
Used technologies:
| Name | Description |
|--------|---|
| [TypeScript](https://www.typescriptlang.org/) | Main Language |
| [Vite](https://vitejs.dev/) | Bundler |
| [React](https://reactjs.org/) | Framework |
| [TailwindCSS](https://tailwindcss.com/) | CSS Framework |
| [PostCSS](https://postcss.org/) | CSS Processor |
| [DaisyUI](https://daisyui.com/) | A tool for transforming CSS with JavaScript |
| [RadixUI](https://www.radix-ui.com/) | Unstyled, accessible components for building highquality design systems and web apps in React |
| [Zod](https://zod.dev/) | TypeScript-first schema validation with static type inference |
| [React Router](https://reactrouter.com/) | Routing. Docs are lame, use [github](https://github.com/remix-run/react-router/tree/main) |
> Planned: [React Hook Form](https://react-hook-form.com/) Forms
Linting, formatting and code editor:
- [VSCode](https://code.visualstudio.com/)
- [ESlint](https://eslint.org/)
- [Prettier](https://prettier.io/)
> Always up-to-date tools rather than stable old.
> It's not intended to be shared, but you can use it if you want.
ToDo:
[ ] Add tests
[?] Add CI/CD
[?] Add SSR (Server Side Rendering)
## Usage
1. Setup `VITE_APP_NAME` in `.env.{mode}` files
2. run: `bun run dev`
3. To build for production, run: `bun run build`
> Use <https://daisyui.com/components> for components styling and <https://www.radix-ui.com/docs/primitives/overview/introduction> for components
### Contact
If you have any suggestions/opinions, please let me know in issues
#### Dev notes
[notes](docs/notes.md)