README.md

bbl-nx

blog & homepage project based on monorepo(nx)

• bbl-nextjs
• bbl-remix (working in progress)

Links

• Homepage
  • https://bbl-nx.vercel.app/
• Storybook
  • Component, Features: https://bobeenlee.github.io/bbl-nx/ui-components/
  • Pages: https://bobeenlee.github.io/bbl-nx/bbl-nextjs

Feature

• Framework: Next.js, Remix
• Deployment: Vercel
• Styling: Tailwind CSS
• Tooling: Storybook
• Build System: Nx.dev

📂 Directory Structure

root
├── apps
├──── bbl-nextjs
├────── src
├──────── apis
├──────── components   # components with next
├──────── libs
├──────── machines     # integrating machines with an api
├──────── pages        # Pages
├──── bbl-remix        # (Working in progress)
├────── app
├──────── apis
├──────── components   # components with remix
├──────── libs
├──────── machines     # integrating machines with an api
├──────── routes       # Routes = Pages
├──────── styles
├── libs
├──── features         # all of the code for a feature and putting it in one single place (ex) authentication - login, signup, user data...)
├──── apis             #
├──── constants        #
├──── hooks            # shared hooks
├──── images           # image assets
├──── libs             # third-party libraries (ex) fetch, axios, sentry...) - facade pattern을 통한 구현
├──── ui-components    # general small components, presentational components (atoms, molecules, organisms, templates)
├──── utils            # very small and simple functions, generally pure function (ex) uri, browser)
├── posts              # MD posts directory
├── tools
├──── generators       # plop-tempates 저장소
└── README.md

Prerequisites

• node version 16.13.2

Installing / Getting started

pnpm install
pnpm install --registry=https://registry.npmjs.org/

Setting up Dev

pnpm start

Tests

Running unit tests

pnpm test:affected

Deployment

• Deploy to Storybook
  • github action master 브랜치 기준 github pages로 배포 진행합니다.
  • ui-components: https://bobeenlee.github.io/bbl-nx/ui-components/
  • features: https://bobeenlee.github.io/bbl-nx/features/
  • pages: https://bobeenlee.github.io/bbl-nx/bbl-nextjs/
• Deploy to Vercel
  • https://bbl-nx.vercel.app/
• Deploy to Netlify (Working in progress)

Dependencies of Graph

pnpm nx graph

Generate UI-Components

pnpm ui-components:new

Supported browsers

• defaults: Browserslist’s default browsers (> 0.5%, last 2 versions, Firefox ESR, not dead).

Document

• XState Machines
• Analytics Report

Gitflow

• git flow release start, finish 2.0.16
• git flow hotfix start, finish 2.0.16-hotfix.0

Contributors

BoBeenLee 💬 📝 🐛 💻 🎨 📖 📋 💡 💵 🔍 🤔 🚇 📦 🔌 👀 📢 ⚠️ 🔧 🌍 ✅ 📹