Skip to content

Latest commit

 

History

History
181 lines (136 loc) · 5.5 KB

README.md

File metadata and controls

181 lines (136 loc) · 5.5 KB
Raw

Movie Magic

Live Demo: Movie Magic Ultimate

Welcome to Movie Magic, the example app for the Code Shaper tutorial. The goal of this tutorial is to demonstrate how code generation can help you build robust applications faster while maintaining code consistency and quality.

We begin by generating a basic web application using your preferred tech stack. From there, we extend it to display a list of top 10 movies of all time. See the screenshot below:

Movie Magic Tutorial

This is just the beginning. With Code Shaper, you can continuously add features to build production-grade applications. We've done precisely that with the Movie Magic Ultimate application included in this repository. This version features a meticulously crafted visual design, a real GraphQL backend, and many other features found in real-world applications. Check out the screenshot below:

Movie Magic Ultimate

What's in this repo?

We have the Movie Magic application coded using 4 different stacks:

  1. Next.js
  2. Vite
  3. Remix
  4. The Ultimate: Next.js + Tailwind CSS + shadcn/ui + Apollo GraphQL

Prerequisites for development

  1. Node Version Manager (nvm) - allows using different versions of node via the command line

Getting Started

# create environment files
cp apps/movie-magic-nextjs/.env.example apps/movie-magic-nextjs/.env.local
cp apps/movie-magic-vite/.env.example apps/movie-magic-vite/.env.local
cp apps/movie-magic-ultimate/.env.example apps/movie-magic-ultimate/.env.local

# build all apps
nvm use        # use the required version of node
npm ci         # install dependencies
npm run build  # build all apps

# run all apps
npm run dev

# in a separate shell
npm run storybook

Open browser windows at the following URLs to see the respective apps:

  1. http://localhost:3000/: Movie Magic | Next.js
  2. http://localhost:3001/: Movie Magic | Vite
  3. http://localhost:3002/: Movie Magic | Remix
  4. http://localhost:3003/: Movie Magic | Ultimate
  5. http://localhost:6006/: Storybook | Next.js
  6. http://localhost:6007/: Storybook | Vite
  7. http://localhost:6008/: Storybook | Ultimate

Note: Do not run npm install or npm ci in any of the subdirectories. It will break the build. There should be only one package-lock.json file in the entire repo (at the root).

All Commands

npm ci                   # install dependencies
npm run build            # builds all workspaces
npm run ci-validate      # builds, lints, formats, and tests all code (runs in CI pipeline, don't run locally)
npm run clean            # deletes all build artifacts
npm run commit           # displays commit helper prompt to ensure your commits use conventional commits
npm run dev              # run app
npm run fix              # lints, formats and attempts to fix any issues (requires `npm run build` has been ran)
npm run format           # formats all workspaces, useful for debugging format issues (generally `npm run fix` is preferred)
npm run lint             # runs the linter on all workspaces, useful for debugging lint issues (generally `npm run fix` is preferred)
npm run storybook        # runs storybook
npm run test             # runs full build, lint, format, and all tests - run before pushing to remote

Common Workflows

Creating New Components

Use Code Shaper to create new components. This will give you a good starting point that is consistent with React best practices.

Here's an example of creating a component called EventList using Code Shaper:

$ npx shaper
? Which plugin would you like to run? React (@code-shaper/react - generates React applications)
? Which generator would you like to run? component (generates a component)
? Component name? (e.g. TextField) EventList
? Which workspace should this go to? apps/movie-magic
? Parent directory within workspace? src/components/EventList

Creating EventList...
  EventList.stories.tsx
  EventList.test.tsx
  EventList.tsx
  index.ts

Done.

Production build

To build all packages and apps for production, run the following command:

npm ci
npm run build

Clean build

Removes all build artifacts and performs a clean build. Run these steps before pushing to remote.

npm run clean
nvm use
npm ci
npm run build
npm run fix
npm test

For an "aggressive" clean build, add a step to remove the package-lock.json file as shown below. This will build the lock file from scratch.

npm run clean
nvm use
rm package-lock.json
npm install
npm run build
npm run fix
npm test

Running unit tests

The following command runs a full build, lint, format, and all tests. However, it uses the Turborepo cache to skip steps that have no changes since the last run. Hence it is very efficient. Always run this command before pushing to remote.

npm test

Running end-to-end tests using dev build

npm run dev # starts a local server hosting the react app

# run e2e tests non-interactively (run in a different shell)
npm run e2e

# run e2e tests in the Playwright user interface (run in a different shell)
npm run e2e:ui

Linting, formatting and fixing coding issues

npm run fix