In this workshop we'll be building a store for a fictional board game company called "The Board Game Hoard".
We're going to be using Nx and some its plugins to accelerate the development of this app.
Some of the things you'll learn:
- Generating a pristine Nx workspace
- Generating frontend Angular apps and backend APIs inside your workspace, with pre-configured proxies
- Creating shared libs for re-using code
- Generating new routed components with all the lazily loaded routes pre-configured by Nx and ready to go
- How to organize code in a monorepo
- Easily move libs around your folder structure
- Creating Storybook stories and e2e Cypress tests for your components
- How to set boundaries between the different scopes in your project
- Write automated source code generators for common tasks in your workspace
- Set-up CI for your Pull Requests
- Add distributed caching
- Set up the NxCloud GitHub integration
- Write advanced deployment targets using the
run-commands
executor - Set up Continuous Deployment systems that deploy only the affected projects
To help you understand how to apply some of these lessons in your own projects, we'll try to build a more "real-world" example. However, because of the time constrains and to make sure we get to cover as much material as possible, we'll provide you with all the code for any "non-Nx" work you need to do (like styling and configuring Angular routes) - so you can focus on learning to use Nx to its full potential.
This is what we'll build:
Can be found here
Nx has support for a lot of platforms, but in this workshop we'll be using mainly Angular. While all the code for any Angular specific work will be provided, it will help if you have some experience with the Angular ecosystem.
Make sure you have the following installed:
- Node.js version 12.14.1 and up
node --version
- Yarn
yarn --version
- A Github account
Optional:
- A Heroku account
- https://heroku.com/
- with the CLI installed:
heroku --version
- Docker
docker --version
Each lab will have the following sections:
- ๐ "Learning outcomes"
- A summary of the most important things you'll learn in that lab
- ๐ฒ "After this workshop, your app should look similar to this"
- This will contain a screenshot of any changes to the app visuals after the lab
- Any changes to the source directory structure
- ๐๏ธโโ๏ธ "Steps"
- All the lab steps you need to follow
While the mighty narwhal is away on secret missions, you will occasionally see his assistant, Ron The Whale ๐ณ offering helpful hints to the different exercises. Please use these if you get stuck.
If you get stuck running any Nx command, there is a SOLUTION.md
file in each lab's folder.
As mentioned, for anything Angular/styling or HTML template work we will provide the code you need as direct links to the files. Please use these as much as possible.
Finally, if you fall behind or join late, Git branches are provided for each lab, which will fast forward you to that lab - git checkout lab-x
(where x
is the number of the lab you want to start).
If you want to skip ahead to the end: git checkout final-solution
Each lab will contain a link to the next one. Start from "Lab 1" and move through them as required:
- ๐ฌ Lab 1 - Generate an empty workspace
- โ๏ธ Lab 2 - Generate an Angular app
- ๐งช Lab 3 - Executors
- ๐ญ Lab 4 - Generate a component lib
- ๐งฌ Lab 5 - Generate a utility lib
- ๐งฎ Lab 6 - Generate a route lib
- ๐ค Lab 7 - Add a NestJS API
- ๐ Lab 8 - Displaying a full game in the routed game-detail component
- ๐ป Lab 9 - Generate a type lib that the API and frontend can share
- ๐ฉโ๐ป Lab 10 - Generate Storybook stories for the shared ui component
- โจ๏ธ Lab 11 - E2E test the shared component
- ๐ก Lab 12 - Module boundaries
- ๐งธ๏ธ Lab 13 - Workspace Generators - Intro
- ๐งต Lab 14 - Workspace Generators - Modifying files
- ๐ Lab 15 - Setting up CI
- ๐ Lab 16 - Distributed caching
- ๐ Lab 17 - NxCloud GitHub bot
- ๐ Lab 18 - Run-Commands and deploying the frontend
Option 1 - React frontends and more custom generators practice | Option 2 - Heroku API deployments with Docker |
---|---|
๐งญ Lab 19 - Creating and deploying a 2nd frontend | ๐งฒ Lab 19 - Deploying the API |
โฑ๏ธ Lab 20 - Mock Store | ๐ธ Lab 20 - Connecting the frontend and backend |
๐ช Lab 21 - Setting up CD for automatic deployment | ๐ Lab 21 - Setting up CD for automatic deployment |
๐ Lab 22 - Deploying only what changed | ๐ Lab 22 - Deploying only what changed |