Need for onboarding documentation for a developer environment

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
azure, docker-compose, react, typescript
Domain
developer-experience, devops, documentation, frontend

Research direction

Start by tracing the game control initialization tool prompts and the Docker Compose setup for the React app. Document the Azure Blob Storage answers and the steps to run the application locally; if the development environment is included, define how React changes use hot module reloading. Done means a new developer can follow the documentation and start the application without the reported uncertainty.

Written by the indexing model from the issue text.

Description

Hello,

I was attempting to onboard this application to my local machine, and I was having a bit of a hard time figuring out how to get the entire application running. There is a lack of documentation on how to get started with a developer environment.

Eventually I was able to get the application running on my machine. Some issues I ran into along the way:

  • When answering the prompts in the game control initialization tool I was not sure what to input for the Azure Blob Storage questions. Some documentation that covers these questions would be helpful for new developers.
  • If any developer tries to make a change in the React app, then they have to manually rebuild the entire React app in order to see the changes. I understand this is a consequence of the current docker compose stack emulating a production stack. Having a separate dev environment with hot module reloading for the React app would help here.

— Danny

Dominant language
TypeScript
Stars
7
Forks
6
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from microsoft/Game-Control-Puzzle-Event-Administration-Tools

All issues in microsoft/Game-Control-Puzzle-Event-Administration-Tools

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.