BuildForSDG / BuildForSDG/Team-006-Backend

[docs] - Project Description in README.md

Open
#18 0 comments 0 reactions 0 assignees View on GitHub
back-end documentation
Dominant language
JavaScript
Stars
2
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### Description

Update `README.md` giving a better description of the project, under the existing headings, including the purpose, how to install and run, and how it is meant to function. If possible, screenshots of db design should be included

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with README.md and review the existing headings. Identify the project's purpose, installation and run instructions, and intended behavior from the repository, then document those sections and include database-design screenshots if available. Done means the README gives a substantially clearer project overview and usage guide.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.