diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..d117323 --- /dev/null +++ b/.env.example @@ -0,0 +1,14 @@ +LITEFS_DIR="/litefs/data" +DATABASE_PATH="./prisma/data.db" +DATABASE_URL="file:./data.db?connection_limit=1" +CACHE_DATABASE_PATH="./other/cache.db" +SESSION_SECRET="super-duper-s3cret" +INTERNAL_COMMAND_TOKEN="some-made-up-token" +RESEND_API_KEY="re_blAh_blaHBlaHblahBLAhBlAh" +SENTRY_DSN="your-dsn" + +# the mocks and some code rely on these two being prefixed with "MOCK_" +# if they aren't then the real github api will be attempted +GITHUB_CLIENT_ID="MOCK_GITHUB_CLIENT_ID" +GITHUB_CLIENT_SECRET="MOCK_GITHUB_CLIENT_SECRET" +GITHUB_TOKEN="MOCK_GITHUB_TOKEN" diff --git a/.eslintrc.cjs b/.eslintrc.cjs new file mode 100644 index 0000000..5dae40c --- /dev/null +++ b/.eslintrc.cjs @@ -0,0 +1,85 @@ +const vitestFiles = ['app/**/__tests__/**/*', 'app/**/*.{spec,test}.*'] +const testFiles = ['**/tests/**', ...vitestFiles] +const appFiles = ['app/**'] + +/** @type {import('@types/eslint').Linter.BaseConfig} */ +module.exports = { + extends: [ + '@remix-run/eslint-config', + '@remix-run/eslint-config/node', + 'prettier', + ], + rules: { + // playwright requires destructuring in fixtures even if you don't use anything 🤷‍♂️ + 'no-empty-pattern': 'off', + '@typescript-eslint/consistent-type-imports': [ + 'warn', + { + prefer: 'type-imports', + disallowTypeAnnotations: true, + fixStyle: 'inline-type-imports', + }, + ], + 'import/no-duplicates': ['warn', { 'prefer-inline': true }], + 'import/consistent-type-specifier-style': ['warn', 'prefer-inline'], + 'import/order': [ + 'warn', + { + alphabetize: { order: 'asc', caseInsensitive: true }, + groups: [ + 'builtin', + 'external', + 'internal', + 'parent', + 'sibling', + 'index', + ], + }, + ], + }, + overrides: [ + { + plugins: ['remix-react-routes'], + files: appFiles, + excludedFiles: testFiles, + rules: { + 'remix-react-routes/use-link-for-routes': 'error', + 'remix-react-routes/require-valid-paths': 'error', + // disable this one because it doesn't appear to work with our + // route convention. Someone should dig deeper into this... + 'remix-react-routes/no-relative-paths': [ + 'off', + { allowLinksToSelf: true }, + ], + 'remix-react-routes/no-urls': 'error', + 'no-restricted-imports': [ + 'error', + { + patterns: [ + { + group: testFiles, + message: 'Do not import test files in app files', + }, + ], + }, + ], + }, + }, + { + extends: ['@remix-run/eslint-config/jest-testing-library'], + files: vitestFiles, + rules: { + 'testing-library/no-await-sync-events': 'off', + 'jest-dom/prefer-in-document': 'off', + }, + // we're using vitest which has a very similar API to jest + // (so the linting plugins work nicely), but it means we have to explicitly + // set the jest version. + settings: { + jest: { + version: 28, + }, + }, + }, + ], +} diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..84a2084 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ + + +## Test Plan + + + +## Checklist + +- [ ] Tests updated +- [ ] Docs updated + +## Screenshots + + diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..7ab7ae7 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,181 @@ +name: 🚀 Deploy +on: + push: + branches: + - main + - dev + pull_request: {} + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +permissions: + actions: write + contents: read + +jobs: + lint: + name: ⬣ ESLint + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + + - name: 🖼 Build icons + run: npm run build:icons + + - name: 🔬 Lint + run: npm run lint + + typecheck: + name: ʦ TypeScript + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + + - name: 🖼 Build icons + run: npm run build:icons + + - name: 🔎 Type check + run: npm run typecheck --if-present + + vitest: + name: ⚡ Vitest + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + + - name: 🏄 Copy test env vars + run: cp .env.example .env + + - name: 🖼 Build icons + run: npm run build:icons + + - name: ⚡ Run vitest + run: npm run test -- --coverage + + playwright: + name: 🎭 Playwright + runs-on: ubuntu-latest + timeout-minutes: 60 + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: 🏄 Copy test env vars + run: cp .env.example .env + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + + - name: 📥 Install Playwright Browsers + run: npm run test:e2e:install + + - name: 🛠 Setup Database + run: npx prisma migrate deploy + + - name: 🏦 Cache Database + id: db-cache + uses: actions/cache@v3 + with: + path: prisma/data.db + key: + db-cache-schema_${{ hashFiles('./prisma/schema.prisma') + }}-migrations_${{ hashFiles('./prisma/migrations/*/migration.sql') + }} + + - name: 🌱 Seed Database + if: steps.db-cache.outputs.cache-hit != 'true' + run: npx prisma db seed + env: + MINIMAL_SEED: true + + - name: 🏗 Build + run: npm run build + + - name: 🎭 Playwright tests + run: npx playwright test + + - name: 📊 Upload report + uses: actions/upload-artifact@v3 + if: always() + with: + name: playwright-report + path: playwright-report/ + retention-days: 30 + + # deploy: + # name: 🚀 Deploy + # runs-on: ubuntu-latest + # needs: [lint, typecheck, vitest, playwright] + # # only build/deploy main branch on pushes + # if: + # ${{ (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') && + # github.event_name == 'push' }} + + # steps: + # - name: ⬇️ Checkout repo + # uses: actions/checkout@v3 + + # - name: 👀 Read app name + # uses: SebRollen/toml-action@v1.0.2 + # id: app_name + # with: + # file: 'fly.toml' + # field: 'app' + + # # move Dockerfile to root + # - name: 🚚 Move Dockerfile + # run: | + # mv ./other/Dockerfile ./Dockerfile + # mv ./other/.dockerignore ./.dockerignore + + # - name: 🎈 Setup Fly + # uses: superfly/flyctl-actions/setup-flyctl@v1.4 + + # - name: 🚀 Deploy Staging + # if: ${{ github.ref == 'refs/heads/dev' }} + # run: + # flyctl deploy --remote-only --build-arg COMMIT_SHA=${{ github.sha }} + # --app ${{ steps.app_name.outputs.value }}-staging + # env: + # FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} + + # - name: 🚀 Deploy Production + # if: ${{ github.ref == 'refs/heads/main' }} + # run: + # flyctl deploy --remote-only --build-arg COMMIT_SHA=${{ github.sha }} + # env: + # FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f9d5ad8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,22 @@ +node_modules +.DS_store + +/build +/public/build +/server-build +.env + +/prisma/data.db +/prisma/data.db-journal +/tests/prisma + +/test-results/ +/playwright-report/ +/playwright/.cache/ +/tests/fixtures/email/ +/coverage + +/other/cache.db + +# Easy way to create temporary files/folders that won't accidentally be added to git +*.local.* diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..668efa1 --- /dev/null +++ b/.npmrc @@ -0,0 +1,2 @@ +legacy-peer-deps=true +registry=https://registry.npmjs.org/ diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..f022d02 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,15 @@ +node_modules + +/build +/public/build +/server-build +.env + +/test-results/ +/playwright-report/ +/playwright/.cache/ +/tests/fixtures/email/*.json +/coverage +/prisma/migrations + +package-lock.json diff --git a/.prettierrc.js b/.prettierrc.js new file mode 100644 index 0000000..b0ffa1c --- /dev/null +++ b/.prettierrc.js @@ -0,0 +1,30 @@ +/** @type {import("prettier").Options} */ +export default { + arrowParens: 'avoid', + bracketSameLine: false, + bracketSpacing: true, + embeddedLanguageFormatting: 'auto', + endOfLine: 'lf', + htmlWhitespaceSensitivity: 'css', + insertPragma: false, + jsxSingleQuote: false, + printWidth: 80, + proseWrap: 'always', + quoteProps: 'as-needed', + requirePragma: false, + semi: false, + singleAttributePerLine: false, + singleQuote: true, + tabWidth: 2, + trailingComma: 'all', + useTabs: true, + overrides: [ + { + files: ['**/*.json'], + options: { + useTabs: false, + }, + }, + ], + plugins: ['prettier-plugin-tailwindcss'], +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..7619ac2 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,11 @@ +{ + "recommendations": [ + "bradlc.vscode-tailwindcss", + "dbaeumer.vscode-eslint", + "esbenp.prettier-vscode", + "prisma.prisma", + "qwtel.sqlite-viewer", + "yoavbls.pretty-ts-errors", + "github.vscode-github-actions" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..374cf10 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,19 @@ +{ + "typescript.preferences.autoImportFileExcludePatterns": [ + "@remix-run/server-runtime", + "@remix-run/router", + "express", + "@radix-ui/**", + "@react-email/**", + "react-router-dom", + "react-router", + "stream/consumers", + "node:stream/consumers", + "node:test", + "console", + "node:console" + ], + "workbench.editorAssociations": { + "*.db": "sqlite-viewer.view" + } +} diff --git a/COMMUNITY.md b/COMMUNITY.md new file mode 100644 index 0000000..269d108 --- /dev/null +++ b/COMMUNITY.md @@ -0,0 +1,12 @@ +# Community + +Here you can find useful learning resources and tools built and maintained by +the community, such as libraries, examples, articles, and videos. + +## Learning resources + +### Videos + +- **Dark Mode Toggling using Client-preference cookies** by + [@rajeshdavidbabu](https://github.com/rajeshdavidbabu) - Youtube + [link](https://www.youtube.com/watch?v=UND-kib_iw4) diff --git a/README.md b/README.md new file mode 100644 index 0000000..b554c2b --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +
+

The Epic Stack 🚀

+ + Ditch analysis paralysis and start shipping Epic Web apps. + +

+ This is an opinionated project starter and reference that allows teams to + ship their ideas to production faster and on a more stable foundation based + on the experience of Kent C. Dodds and + contributors. +

+
+ +```sh +npx create-remix@latest --typescript --install --template epicweb-dev/epic-stack +``` + +[![The Epic Stack](https://github-production-user-asset-6210df.s3.amazonaws.com/1500684/246885449-1b00286c-aa3d-44b2-9ef2-04f694eb3592.png)](https://www.epicweb.dev/epic-stack) + +[The Epic Stack](https://www.epicweb.dev/epic-stack) + +
+ +## Watch Kent's Introduction to The Epic Stack + +[![screenshot of a YouTube video](https://github-production-user-asset-6210df.s3.amazonaws.com/1500684/242088051-6beafa78-41c6-47e1-b999-08d3d3e5cb57.png)](https://www.youtube.com/watch?v=yMK5SVRASxM) + +["The Epic Stack" by Kent C. Dodds at #RemixConf 2023 💿](https://www.youtube.com/watch?v=yMK5SVRASxM) + +## Docs + +[Read the docs](https://github.com/epicweb-dev/epic-stack/blob/main/docs) +(please 🙏). + +## Support + +- 🆘 Join the + [discussion on GitHub](https://github.com/epicweb-dev/epic-stack/discussions) + and the [KCD Community on Discord](https://kcd.im/discord). +- 💡 Create an + [idea discussion](https://github.com/epicweb-dev/epic-stack/discussions/new?category=ideas) + for suggestions. +- 🐛 Open a [GitHub issue](https://github.com/epicweb-dev/epic-stack/issues) to + report a bug. + +## Branding + +Want to talk about the Epic Stack in a blog post or talk? Great! Here are some +assets you can use in your material: +[EpicWeb.dev/brand](https://epicweb.dev/brand) + +## Thanks + +You rock 🪨 diff --git a/app/components/confetti.tsx b/app/components/confetti.tsx new file mode 100644 index 0000000..69fbece --- /dev/null +++ b/app/components/confetti.tsx @@ -0,0 +1,21 @@ +import { Index as ConfettiShower } from 'confetti-react' +import { ClientOnly } from 'remix-utils' + +export function Confetti({ id }: { id?: string | null }) { + if (!id) return null + + return ( + + {() => ( + + )} + + ) +} diff --git a/app/components/error-boundary.tsx b/app/components/error-boundary.tsx new file mode 100644 index 0000000..e0f7f43 --- /dev/null +++ b/app/components/error-boundary.tsx @@ -0,0 +1,45 @@ +import { + isRouteErrorResponse, + useParams, + useRouteError, +} from '@remix-run/react' +import { type ErrorResponse } from '@remix-run/router' +import { getErrorMessage } from '#app/utils/misc.tsx' + +type StatusHandler = (info: { + error: ErrorResponse + params: Record +}) => JSX.Element | null + +export function GeneralErrorBoundary({ + defaultStatusHandler = ({ error }) => ( +

+ {error.status} {error.data} +

+ ), + statusHandlers, + unexpectedErrorHandler = error =>

{getErrorMessage(error)}

, +}: { + defaultStatusHandler?: StatusHandler + statusHandlers?: Record + unexpectedErrorHandler?: (error: unknown) => JSX.Element | null +}) { + const error = useRouteError() + const params = useParams() + + if (typeof document !== 'undefined') { + console.error(error) + } + + return ( +
+ {isRouteErrorResponse(error) + ? (statusHandlers?.[error.status] ?? defaultStatusHandler)({ + // @ts-expect-error, pretty sure this is a bug in Remix + error, + params, + }) + : unexpectedErrorHandler(error)} +
+ ) +} diff --git a/app/components/floating-toolbar.tsx b/app/components/floating-toolbar.tsx new file mode 100644 index 0000000..41b5be0 --- /dev/null +++ b/app/components/floating-toolbar.tsx @@ -0,0 +1,2 @@ +export const floatingToolbarClassName = + 'absolute bottom-3 left-3 right-3 flex items-center gap-2 rounded-lg bg-muted/80 p-4 pl-5 shadow-xl shadow-accent backdrop-blur-sm md:gap-4 md:pl-7 justify-end' diff --git a/app/components/forms.tsx b/app/components/forms.tsx new file mode 100644 index 0000000..0d362fc --- /dev/null +++ b/app/components/forms.tsx @@ -0,0 +1,148 @@ +import { useInputEvent } from '@conform-to/react' +import React, { useId, useRef } from 'react' +import { Checkbox, type CheckboxProps } from './ui/checkbox.tsx' +import { Input } from './ui/input.tsx' +import { Label } from './ui/label.tsx' +import { Textarea } from './ui/textarea.tsx' + +export type ListOfErrors = Array | null | undefined + +export function ErrorList({ + id, + errors, +}: { + errors?: ListOfErrors + id?: string +}) { + const errorsToRender = errors?.filter(Boolean) + if (!errorsToRender?.length) return null + return ( +
    + {errorsToRender.map(e => ( +
  • + {e} +
  • + ))} +
+ ) +} + +export function Field({ + labelProps, + inputProps, + errors, + className, +}: { + labelProps: React.LabelHTMLAttributes + inputProps: React.InputHTMLAttributes + errors?: ListOfErrors + className?: string +}) { + const fallbackId = useId() + const id = inputProps.id ?? fallbackId + const errorId = errors?.length ? `${id}-error` : undefined + return ( +
+
+ ) +} + +export function TextareaField({ + labelProps, + textareaProps, + errors, + className, +}: { + labelProps: React.LabelHTMLAttributes + textareaProps: React.InputHTMLAttributes + errors?: ListOfErrors + className?: string +}) { + const fallbackId = useId() + const id = textareaProps.id ?? textareaProps.name ?? fallbackId + const errorId = errors?.length ? `${id}-error` : undefined + return ( +
+