nrwl / nrwl/react-template

Missing deployment instructions

Open
#8 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
7
Forks
4
Avg merge
3d 1h
Merged PRs (30d)
1

Description

Currently there is no setup nor instructions for deploying the shop and api services with docker.
While performing nx build shop generates in the dist folder a frontend bundle that can be easily deployed, doing nx build api is not enough (see this nx issue).
For this template to be effectively useful I think there should be at least instructions on how to deploy the backend and frontend with docker, even better if it is already setup.

Also in "Adding New Features" section it is not present the command to create a new backend app (e.g. npx nx g @nx/node:app myapp)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository documentation, especially the "Adding New Features" section, and verify the existing nx build shop and nx build api behavior. Document Docker deployment steps for the shop and API services, and add the backend app generation command; the work is done when a user can follow the instructions to deploy both services and create a backend app.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, typescript
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.