diff --git a/.gitignore b/.gitignore index ceaea36..8dadeb3 100644 --- a/.gitignore +++ b/.gitignore @@ -129,4 +129,94 @@ dist .yarn/build-state.yml .yarn/install-state.gz .pnp.* +# ------------ +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser +# ---------- +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +!.vscode/*.code-snippets + +# Local History for Visual Studio Code +.history/ + +# Built Visual Studio Code Extensions +*.vsix diff --git a/README.md b/README.md index 5c7b314..2f9724e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,50 @@ # DaisyUI-React-Starter -DaisyUI React Starter provides a ready-to-use template with Tailwind CSS within a React environment. Kickstart your project with a clean, organized structure, and pre-configured DaisyUI components, making the initial setup seamless and accelerating your development process. \ No newline at end of file +[![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. + +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 high‑quality 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 for components styling and for components + +### Contact + +If you have any suggestions/opinions, please let me know in issues + +#### Dev notes + +[notes](docs/notes.md)