Project structure update

Open
#7 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
build-system, documentation

Research direction

Start in the project root by inspecting the existing frontend and backend structure, then plan the README.md sections around the project's features, motivation, tech stack, and layout. Review how the frontend and backend are started before defining useful scripts in package.json. Done means both files document the project clearly and provide working start commands.

Written by the indexing model from the issue text.

Description

Please write a README.md for the project root that:

  • Introduces the project (features, motivation, tech stack etc)
  • project structure and explanation

also, a package.json that defines some useful scripts, e.g. starting the backend/frontend

Dominant language
TypeScript
Stars
0
Forks
1
No merged PRs in 30d

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.

More from usdevs/QueueBot

All issues in usdevs/QueueBot

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.