jknight/yarn-v2-workspace-docker-vs-code

A technology demonstration of the Plug'n'Play and workspace features of Yarn v2, Docker Compose, Visual Studio Code, TypeScript, Webpack, Babel, ESLint, Prettier and Jest

This repo uses a simple full-stack JavaScript web application to demonstrate the tooling setup for a local development environtment that brings together the following tools and technologies:

• Docker Compose.
• The following features of Yarn v2:
  • workspaces.
  • Plug'n'Play.
• The following features of Visual Studio Code:
  • The Remote Container Extension.
  • IntelliSense provided by the TypeScript language server.
  • The Prettier formatter extension.
• TypeScript (and by extension, JavaScript, of which TypScript is a strict superset).
• Webpack.
• Babel.
• ESLint.
• Prettier.
• Jest.

The demo application is an interactive in-browser explorer of the Star Wars API, which contains the data about all the Star Wars films, characters, spaceships and so on. If you want to quickly try the application out, here is the online version created by the GraphQL team.

For a high-level tour of this repo, please see the accompanying blog post.

Prerequisites

• Docker
• Visual Studio Code and the Remote Container Extension.

Because these prerequisites are available on Windows, Mac and Linux, the functionality contained in this repository should be the same across all those platforms.

Instructions

To get the demo application up and running, follow these steps:

• cd into the project directory.
• Run docker-compose build base.
• Run docker-compose up -d.
• Navigate to http://localhost:32804 in your browser (32804 is the default value of the $FRONT_END_HOST_PORT environment variable).
• To use the preconfigured Docker-based Visual Studio Code development environment, with the Docker containers already up and running, open the Command Palette (Cmd+Shift+P), choose "Remote Container: Open Folder in Container" and choose the vs-code-container-back-end in the project directory for the back-end or vs-code-container-front-end for the front-end.

Available tasks

The following tasks are available in both the front-end and back-end workspaces.

• build: make a production build without serving it.
• clean: clear away all build artifacts.
• format: automatically format code styling with Prettier.
• lint: run ESLint with automatic fixes.
• serve: serve the build output.
• start: make and serve a development build and recompile on change.
• typecheck: perform type checking with the TypeScript compiler without outputting any code.

The front-end has the following additional tasks:

• test: run tests with Jest
• test:watch: run test with Jest in interactive watch mode on the command line.

To run a task, e.g. lint, in a particular workspace, e.g. front-end, either run yarn workspace front-end lint from anywhere in the project or run yarn lint from within the front-end workspace (packages/front-end).