Skip to content

ryan-ahn/npm-react18-starter

Repository files navigation

Ryan's React18 Awesome Starter

Author License Last Commit

Features

  • ⚙️  Small & Fast Bundler (Vite)
  • 🗝️  Typed Programming (Typescript)
  • 🕋  Simple Store (Zustand)
  • 📙  Configure Formatter (ESLint + Prettier)
  • 🧵  Built-in Component & Layout
  • 🧩  High Order Component
  • ✨  Setting Reset Style
  • ⚡️  Setting Style Set
  • 🗂️  Page Helmet SEO
  • 📍  Absolute Path
  • 📱  Check Device
  • 🪄  Theme Mode

Frameworks

  • Bundler : Vite
  • Core : React18
  • Store : Zustand

Code Structure

  • Static(public)
  • Root(src)
  • ⎣ components - atomic stateless components
  • ⎣ containers - stateful components
  • ⎣ constants - static resource
  • ⎣ interface - interfaces
  • ⎣ layouts - layouts
  • ⎣ router - routers
  • ⎣ libs - store, hooks, utils
  • ⎣ styles - style set

Getting Started

1) Installation

npx react18-starter my-project
cd my-project

2) Run development

npm run dev

Using with Style set

const Style = styled.div`
  // flex set(justify-content, align-items, flex-direction)
  ${({ theme }) => theme.flexSet('center', 'center', 'column')};

  // box set(width, height, border-radius)
  ${({ theme }) => theme.boxSet('00px', '00px', '00px')};

  // color set(color, background-color)
  ${({ theme }) => theme.colorSet('white', 'black')};

  // background set(url, object-fit)
  ${({ theme }) => theme.backgroundSet('URL','contain')};

  // font set(font-size, font-weight, line-height)
  ${({ theme }) => theme.fontSet(00, 000, 00)};
`